Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

Table of Contents

Goals

Recognize that some documentation applies only to a particular release, or set of releases.

Recognize that documentation will most likely be found by web searches, not by walking the wiki.

Information about the current release should be the easiest to find.

Information about older releases should be available somewhere.

There should be an area for documenting new features before they are included in a release.

It should be easy to tell whether the information you are viewing is correct for the code you are using.

Documentation should not be frozen at release time - It should remain available for improvements.

The most basic instructions should be included in the release.

Novice users should be able to find what they need; expert users should be able to find more

...