Documentation Ideas | cern archive | HTTP only
home archive home about

Audience

We need to consider
  • - Who the audience are.
  • - What they need to know in order to use the program.
  • - What we can assume they know already (nothing?).

    Users

    Require a simple and short users guide, which includes the basic description of the program, how to use it, and how to install it.

    Maintainers

    Require the internals of the program, in order to debug, if in the future, problems arise. They need to have an overview of the program, mentioning any departures from normal practice. They need to have details of the structural layout of the program and information concerning any setups required, aswell as a list of files which are needed to be linked into the program, and details of which operating system should be used.

    Documentation should be kept simple and short.