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.



  • Use just one page for all content
  • Start with source code
  • Duplicate content across wiki pages and the regular webiste
  • ...
Topic revision: r3 - 29 Nov 2016, EikeJuerrens
Legal Notice | Privacy Statement

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Wiki? Send feedback