Next
Previous
Contents
This isn't a hard and fast guide on writing good documentation (yet), but
consider it a bunch of hints to help you along as you write.
- Be clear. Everyone needs to know what you're talking about.
- Use examples where possible. It lets everyone see what you're talking about.
- Organize. Don't jump between unrelated topics in the same section.
You can get many more hints from the LDP style guide located at
http://www.linuxdoc.org/HOWTO/LDP-Style-Guide.html.
Next
Previous
Contents
Copyright © 2005 LinuxSelfhelp.com. All rights reserved