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

Dont's

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

Metadata

  • Topic created by: DanielNuest
  • Topic created on: 2013-02-20
Tags:
create new tag
, view all tags
Topic revision: r1 - 2013-02-20 - 13:31:19 - DanielNuest

 
  • Search: 
This site is powered by the TWiki collaboration platform Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback