dominicclifton wrote:
Awesome! Creating good documentation is hard and I thank you for wanting to help with this!
Here's a few thoughts on this subject, of the top of my head - in no specific order.
1) We don't ever want the documentation to get out of sync with the code. If it lives with the code it's easier to update it at the same time.
Agreed, but somewhat idealistic. I do not know of any project for which there is not stale or outdated information on the 'web, and I do not think CF is going to be the first.
We are still talking about where it will live. Allowing others to keep it up to date is definately a concideration.
2) We don't want duplicate or conflicting documentation.
Uhhhh... Duplicate or conflicting information on the internet?! Nahhh, That'll never happen!
I can control what is in my single document, and I certainly accept redlines to remove/correct duplicate or conflicting information, but that is all.
3) Keeping the documentation with the code makes it easy for others to access and change, not as easy as a wiki but wiki's go out of date very quickly.
See above.
4) I've been using markdown format, since markdown is displayed on the github pages.
5) I'm not averse to having a publishing step or a command to build the documentation from a set of source files, if required.
Both good ideas, but a static PDF, (and thus "out of sync" soon after it is published) is probably what we will have at least for the short term.
6) Publishing to PDF or Static HTML (single or multi page) would be nice - e.g. to be available as downloads.
Yeah, again trade off between something we can publish as a nice downloadable document, and the ease of keeping it up to date with the code.
7) Screenshots go out of date and are time consuming to re-create, use sparingly.
Agreed, but customers (esp Noobs) like screenshots. Right now I have a few.
8) Connection photos don't go out of date as quickly, are very useful but are also time consuming to create.
Already done, but subject to change.
9) Documentation should be purely factual, contain no opinions and be backed by references and links where possible (like wikipedia).
Errrmmm.. Well I do put humor and personal expirience in the documentation I write. Look in the book store. Dry text is just not what people want to read.
"...for Dummies" and other books with humor and cutsie graphics is what people will read.
Developers can look at the code. Readable documentation opens the user base to more people.
I think we may need 2 sets of documentation -- a Wiki or markdown, and a "pretty" PDF.
I am willing to do a 2nd version in markdown, with just the basic formating, and no "editorial".
Of course I can't promise to maintain it "in perpetuity" (I drink too much Pepsi to be around when perpetuity gets here.)