How to write a User Guide (Help wiki)
From UG
(Difference between revisions)
m (→Imtro) |
|||
Line 14: | Line 14: | ||
Most probably these wikis will be linked from App itself. | Most probably these wikis will be linked from App itself. | ||
+ | |||
+ | == Principles == | ||
+ | |||
+ | * keep it short | ||
+ | * do not state obvious | ||
+ | * state most important first | ||
+ | * first version of article may contain not all info | ||
+ | * template: [[Help wiki template]] | ||
== Useful links == | == Useful links == |
Current revision as of 01:59, 26 March 2011
[edit] Intro
This article explains how to write guides in Category:User Guides
These guides should be useful for and readable by:
- end user
- support
- developers
- salesman
- executives
Most probably these wikis will be linked from App itself.
[edit] Principles
- keep it short
- do not state obvious
- state most important first
- first version of article may contain not all info
- template: Help wiki template