Skip to main contentDX
- Digital Ocean
- make your documentation delightful
- organize by what developers are trying to do
- show the simple version first, and layer in complexity as needed
- use error documentation
- show code in context
- easy to follow pagination
- api endpoint naming. Remove vs delete, for example, can do the same action but have different words. Kee0 consistent
- consistency and predictably. Not cleverness. Consistent apps
- SDKs
Error messages
- should have what, why, how, and where
- include an ID for the error message so the dev has something to reference when they contact tech
CLI
- ci/cd, terminal, shell script, ai agent
- if a command fails, tell why and provide helpful information
- help command is an example
3 practical tests
- on boarding experience. Time the first run experience from 0
- look at unsolved tickets, sort by patterns. Can clearer docs, cleaner command, etc make this better?
- find an unsuspecting victim
Friction audit
- map out entire journey and ask where a dev gets stuck, annoyed