Documentation

[christopherfowers]

Documentation should be maintained for both the End Users and the Developers. Github provides a basic wiki system which should be sufficient for now. Depending on the growth of the application, there may need to be consideration given to move on to something a bit more flexible.

The benefits of documenting in a single location (i.e. the wiki)

• Accessibility to Up To Date relevant information
• Source Controlled. Can roll back if necessary
• Can be linked from within the application for End User Help functionality
• Can be Used as an easy means to keep valid references to Licenses
• Perfect for Development Environment Setup Information
• Good For General Development Documentation (i.e. details on bug-fixes)

Considerations for documentation

• How To Articles (For Developers and End Users)
• Exercises
• Settings
• Revision History (changelog - Just needs copied from already existing source)

[chaosbastler]

I guess you're right, more documentation would be nice.

Besides the readme of this project there is only an old (not up-to-date) documentation of the exercise-XML format: https://github.com/chaosbastler/opentraining-exercises/blob/master/README.md

[christopherfowers]

I'll do my best to document as much as possible. I realize that I am not near familiar enough to do so effectively on most of the existing and planned development just yet. I'll spearhead this though... It's never been a favorite of any developer but its value surpasses the effort by far. As I write articles, please check behind me and snap a whip on me if I misinform in them.