Tuesday, March 25, 2008

Software documentation

There are two types of documentation which should be created for software. Those that are used internally within the company, and those that are used externally, by the customer.

Some examples:


Internal

Explanations of software.
  • What it is for
  • Who the intended users are
  • How it works
  • How it is developed
Sales tools


External

User guides

  • System requirements
  • Basic (user guide)
  • Advanced (user guide)
  • Installation
  • Upgrading
  • Troubleshooting
  • Moving an installation between machines

0 comments:

Post a Comment

Note: only a member of this blog may post a comment.