Documentation
Jump to navigation
Jump to 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:
- in man pages via the man command
- at the given project's web page, in their documentation area
- in Howto documents -- howto's are easily obtainable from The Linux Documentation Project or by googling (Google) for them.
- using the info command (to view the texinfo manual, if there is one)
- here at the LinuxQuestions.org Wiki
- by searching relevant newsgroups' and mailing lists' archives
- by searching the LinuxQuestions.org[1] forum archives[2]
- on your own system in /usr/share/doc and elsewhere
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
- The Linux Documentation Project
- Rute User's Tutorial and Exposition
- IBM Developerworks
- A lot of stuff to check, even in the Unix section.
- www.howtoforge.com
- Open Books
- www.debianadmin.org
- Very good articles. Active.
- en.wikibooks.org
- Should be watched closely. Example, some books for the Newbies :
- Yolinux's tutorials
- Doctor Bob's low fat Linux
- An ordered resource of lessons to learn Linux basics, the Unix way.
- tuxfiles -- Linux help
- 20 Must Read HOWTOs and Guides for Linux