Documentation

From LQWiki
Jump to: navigation, search

Documentation is any document that provides information about the configuring, running, troubleshooting, fixing or general using an application or piece of hardware.

Look for GNU/Linux documentation:

When writing your own documentation, please keep the 3 C's in mind:

  • Make it Correct,
  • Concise, and
  • Complete.

Of course, keeping your docs up to date and also understandable by your intended victims^h^h^h^h^h^h^h users goes without saying. :)

References

See also

External links