Follow the archetype below when writing new technical documentation for the Wiki. This format encourages you to write concisely and effectively. Feel free to edit this page and copy-and-paste the content below into your new document. Use one page per topic or task.
If this is strictly a process or task, use a concise description of the process as the article title. Explain what this command, program, feature, or process is, and where it is used. Let readers know that this is the right process to follow for their situation.
What are the prerequisite conditions for this task? Which versions of the software does this apply to? Which platforms? Also provide definitions of technical terms that users need to know in order to follow the instructions.
Explain briefly to users how they will know that the process was successful. Sometimes this is obvious; if so, leave this section out.
Reserve your sample code, example text, and screen shots for this area unless it is absolutely necessary to include them above.
What can go wrong? Cover common and known problems, then cover how you can discover the root of a problem (logging, debugging symbols, etc.)