52°North is migrating this TWiki to foswiki which will become availabe via the well known domain wiki.52north.org soon.
Hence, this wiki is switched to read-only mode starting Monday - 27.06.2016 - until the end of the migration. Hence, save your changes beforehand.
The 52°North IT-Team.
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 created by: DanielNuest
- Topic created on: 2013-02-20
Topic revision: r1 - 2013-02-20 - 13:31:19 - DanielNuest