Detail default documentation format and how deal with binary files

[aschrijver]

(This issue is based on a copy of discussion with @georgeshk in #27)

For binary files we should have a way to know which version of the Markdown document they relate to, and indicate the version in the filename.

The standard documentation format is markdown, because it is common text-only document type, that you can open in any text editor on any platform, and that is displayed with rich formatting on Github and on the forum.

But when having digital documents it becomes hard to judge if they are in sync with the markdown. I suggest having the 'source of truth' be markdown, and when creating an actual RFP to make a markdown copy in the right location, finalise the text and add links to any binary formats in the same folder that have been created from it.

PS. Binary formats create contribution barriers, but we'll still need them. I do not have Word, but can read docx in OpenOffice, but not save while keeping the exact same formatting. We will also have people creating Illustrator, Photoshop and InDesign documents, etc. later on, that need payed software subscriptions. That should be less of a problem, but this is a template, so more important.

PS2. There is an additional risk to uploading binary files, especially Word documents: If one person's PC is infected with viruses, then it will spread to others opening the file.

[patmatsu]

PS2. There is an additional risk to uploading binary files, especially Word documents: If one person's PC is infected with viruses, then it will spread to others opening the file.

Does GH not have virus-scanning abilities?

[aschrijver]

I am not sure. Github (and git itself) is not really meant for binaries. There is a large files extension services though, that offers 1 GB of space for free. Maybe that scans.