Main Page
From Write A Better FM
Write A Better FM
Have you ever noticed that the Open Source projects most likely to tell you to RTFM are the same ones who don't have an FM that's worth R'ing? Why is that? This website is an attempt to get to the bottom of that mystery, and provide some best practices, tools, and examples for documenting Open Source projects.
Table of Contents
- Introduction
- Don't be a jerk
- Defining your audience
- Listening to your customers
- Project management (Governance, leadership, etc)
- Documentation format
- Wikis
- Online docs
- Packaged docs
- Translations
- Documentation organization
- The formal manual
- Tutorials/Howtos
- FAQs
- StackOverflow
- Writing
- Examples
- Involving the community
