Documentation Standards & Guidelines

General Style Guidelines

1. Language should be English
1. Style should tend more toward "user manual" than "blog post".
1. Images should (where possible) be located in the wiki git repository in 'img/'.

Applications Pages should adhere to he following structure:

This is a brief description of the Application. Limit to 3 or 4 sentences. No need for elaboration of terms or definitions.

What the various regions and controls on the UI do. This should contain a screenshot with the various regions highlighted.

Detailed description of the usage of the application.

Specific use-cases. Possible inclusions - sample file outputs, screenshots etc.

Note

The wiki is incomplete. Please add content and collaborate.

Important

This is a public wiki. Everything is visible to everyone. Don't use it for personal notes.
Avoid linking to external tutorials/articles; they may become outdated or contain false information.