How to write a User Guide (Help wiki)

From UG

(Difference between revisions)
Jump to: navigation, search
 
(2 intermediate revisions not shown)
Line 1: Line 1:
[[Category:Help]]
[[Category:Help]]
-
== Imtro ==
+
== Intro ==
This article explains how to write guides in [[:Category:User Guides]]
This article explains how to write guides in [[:Category:User Guides]]
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 ==
Line 20: Line 28:
* http://www.techscribe.co.uk/ta/how-to-write-user-documentation.htm
* http://www.techscribe.co.uk/ta/how-to-write-user-documentation.htm
* http://www.ehow.com/how_2131551_great-user-guide-almost-anything.html
* http://www.ehow.com/how_2131551_great-user-guide-almost-anything.html
 +
* http://www.helpscribe.com/

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

[edit] Useful links

Personal tools