Writing Reasonable Documentation
I find it strange that most people seem to be rather horrible at writing documentation. While this is simply a subjective opinion of mine (who am I to say that I am any better than they), it is one that many of my colleagues share.
Writing documentation, once you're in the mood for it, is quite easy. You simply explain how to understand/use a piece of software in a concise, mildly entertaining fashion.
- Don't explain everything - leave some mystery.
- Explain what needs to be explained, and get on with it.
- Show some examples.
- Expect people to skip over most large blocks of text, so avoid them entirely.
Ideally, the software does a good job of explaining itself. If not, you may want to consider a new approach to your design (or accept the complications of your codebase's territory).
That's the best advice I can give to anyone trying to write better documentation (if they consider mine to be of any merit, that is).
Thoughts & Musings: a (Public) Journal
A collection of hand-written essays by Kenneth Reitz.
- My Last Manic Episode.
- The Secret to My Success: Stimulants.
- Competition and Open Source.
- My Favorite Python Libraries.
- On Polyamory.
- A Good Hat.
- Working from Home — a Double-Edged Sword.
- Dinner with a Narcissist.
- Truest Love.
- Writing Reasonable Documentation.
- On Traveling and Depression.
- On Conferences and Travel.
- The Far Side of Madness.
- Pipe Dream: Making a Game.
- On Depression, Part I (of many).
- A Concise List of Personal Values.
- On Psychedelics and Other Drugs.
- On Depression, Part II.
- Why This isn't a Blog.
- Back to Work.
- Stuck in a Rut.
- It's About Time....
- On Inspiration and Tools (like languages).
- New Project Idea: Environment Variables.
- On Open Source and Impactfulness.
- Living With Reasonable Regrets.
- The Anxiety of Clout.
- Positivity, Coming Soon™.
- Fellowship at PyCon (upcomming).
- Seeking Inspiration, Somewhere.
- Soul Purpose.
- Sharing is Therapeutic.
- First Entry.
- On Writing Music and Emotional Landscape.
- Esoteric Interest and Current Bookshelf.
- Three Concise Truths.
- I Love Typography.