How to write a User Guide (Help wiki)

From UG

Revision as of 01:59, 26 March 2011 by Alex (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search


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.

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

Personal tools