Cox Media Group
KryptoniteConference Schedule
Track one or two? Eeenie, meenie, miney, moe…
RTFM -- wRite The Friendly Manual
Time
Level
Description
Abstract
Sections 1-3 are intended to be short but sweet, introducing a few essential topics to set the stage for what comes after. Section 4 is where the real meat begins, covering some basic principles of actual writing. Sections 5-6 return to technical matters, with most of the focus being on overviews rather than in-depth tutorials on specific tools or services.
- The two kinds of documentation
- Documentation for people who will hack on your code
- Documentation for people will run your code
- Why you need both!
- Support mechanisms
- The other two kinds of documentation
- Hand-written explanations
- Auto-generated API references
- Why you need both!
- Support mechanisms
- The mindset
- DDD -- Documentation-Driven Development
- Write documentation before code
- Documentation as specification
- The style
- "Raise your hand if you have a liberal-arts degree"
- A whirlwind tour of good prose
- Be friendly!
- Writing to your audience
- How to write a how-to
- The tools
- reST
- Sphinx
- pydoc/epydoc/etc.
- Django!
- The rest
- What your file layout should look like
- Magical distutils incantations
- Hosting
- On your own
- On packages.python.org
- On readthedocs
- Other options
- Feedback
- Why "documentation" is a component in your issue tracker
- How to handle suggestions gracefully
- Questions?