Documentation as User Experience
summary
Argues that documentation must be treated as user experience and gives concrete practices: keep docs with code in source control, generate diffs and changelogs, and wire docs into CI/CD so edits travel with commits. Distinguishes three useful doc types—reference narrative concept—and shows tools that work (Plaster scaffolding, Documentarian, Platypus conversion, git/GitLab flows) including a working build script and live preview that generates a website from markdown.
AI-written summary · about
chapters (10)
- 0:00Intro
- 1:28UX
- 5:09Types of Docs
- 11:48Reference Docs
- 13:51Narrative Docs
- 17:10Concept Docs
- 20:34Forms
- 21:56Chat
- 29:28Non Written Docs
- 31:26PowerShell Demo
