We can all agree the world is under-documented. However, some of the documentation that currently exists, shouldn't, and it trains users to ignore the other docs we've spent so much time crafting.
We'll talk about common documentation traps, including autogenerated text and poka-yoke replacements, and how to recognize and purge them in your own projects to create a better user experience.
- Introduction
- Me
- iFixit/Dozuki/tech writing program/HBR article
- About the title
- Good documentation's worst enemy is bad documentation
- "Documentation sucks"
- Bug in software, we might say "never use this software" (ImageMagick)
- Bug in documentation, we say "never use any documentation"
- In general, we're all numb to documentation - we don't read it because we
expect it to be bad.
- Sometimes this bites us in the butt - my magnet-powered flashlight.
- Broken window syndrome. Bad docs beget bad docs.
- (Aside) Outdated docs
- How do we solve this? Pre-merge documentation update requirement
- Code + docs + tests + metrics + alerts
- Auto-generated docs
- Laziness, impatience, hubris.
- Laziness leads to computers writing documentation, which sucks.
- Humans read your docs, so humans need to write them.
- Overly-verbose instructions.
- Omit
needlesswords. - Know your audience - don't write super-introductory text for experienced users.
- Omit
- Poka-yoke replacements.
- git-scripts feature/hotfix merge