Best Practice for Software Documentation in the Wiki

It is hard to define clear guidelines for documentation. Things rely heavily on the software at hand: is it a client for users, is it a server documentation in beta stage? On this page we should collect some "do" and "do not do" items for starters until we can better phrase the requirements.

Do's

• Split up user and developer documentation
• Use a clear license for the documentation, see PublishPageUnderCreativeCommons
• Use sensible WikiWords for page names, e.g. ProductNameHelp, ProductNameDevelopment, ProductNameExamples
• Must have content for main page
  • About
  • Features
  • Demo/screenshots/examples
  • Download/installation
  • Contact
• Must have content for development page
  • How to set-up a development version
  • ...

Dont's

• Use just one page for all content
• Start with source code
• Duplicate content across wiki pages and the regular webiste
• ...