Make Great Documentation
Writing documentation is a skill, just like programming or riding a bike or yodeling. If your project lacks great documentation, it's likely for the same reason that it lacks groovy yodeling tunes. You have no idea what's involved or where to begin.
That's where this site comes in. It gives you a starting point by providing:
- A tool for creating documentation
- Guidelines for writing documentation
- Examples of great documentation
1. Links
1.1. Examples of Great Documentation
- nanoc, a ruby static site generator (which this site is built with)
- django, a python web framework
- The stripe API, the API for a payment processing service
- docco.coffee, a literate programming documentation generator
- backbone.js API, API documentation for a javascript MVC framework
- yardoc, the project page for a Ruby documentation tool
1.2. Project Links
1.3. Other Documentation Tools
2. TODO
- Explain scss layout
- More HOWTO on doing less obvious stuff
- Syntax highlighting
- Textile
- Explain when a user would want to look at nanoc docs
- Syntax highlighting
- Elaborate on writing guidelines