Documentation is UX! - Change my mind
summary
Argues documentation is part of user experience and shows concrete results: a documentation pipeline built in under a day that generates cmdlet help with the Platypus module, renders a site with Hugo + GitHub Actions + GitHub Pages, and adds preview builds via Netlify for pull requests. Compares formats—420‑page IKEA vs 4,500‑piece Lego manuals—to show different emotional effects, stresses reference/conceptual/narrative docs, and gives actionable fixes like searchable docs and editable GitHub pages.
AI-written summary · about
chapters (16)
- 0:00Welcome
- 1:27UX beyond interface
- 2:54UX in CLI & GUI
- 6:08The role of metaphors in user experience
- 7:11Documentation as part of the user experience
- 12:10PowerShell docs impact
- 15:19Why docs matter
- 16:42Improving module docs
- 19:50User stories for docs
- 22:39Three docs types
- 26:08Dev experience & comments
- 29:37Docs writing strategies
- 32:04Publishing accessible docs
- 34:55Free docs pipeline
- 37:41Contributor docs experience
- 39:46Summary & call to action
related talks
40mDocumentation as User Experience
29mHumanizing Your Documentation
39mInvisible influence: the documentation behind UX copy
24mRe-thinking product adoption through documentation design
06mThe Importance of Good UX
05mTurning cooperation into collaboration: A UX writing case history
40mWhen documenting is designing
13mThe UX of UX - Behind the scenes of effectively designing in the open