Long-term Documentation Maintenance
summary
Argues that long term docs survive only when people plus modest tooling cooperate and gives concrete tactics: use self documenting code and linters for reliable samples, adopt structured content and single sourcing to avoid duplication, run automatic generation for API snippets, track docs in an ITSM register (example 624 resources) and enforce scheduled review tasks (right now 29 past-review items), combine metrics driven reviews, user bug reports and a dedicated reviewer role because technology alone does not solve drift
AI-written summary · about
chapters (14)
- 0:00Start
- 2:44THE DREAM
- 3:50DEFINITIONS
- 5:02CRITERIA
- 9:17SELF-DOCUMENTING CODE?
- 11:47WELL-COMMENTED CODE?
- 13:22STRUCTURED CONTENT (DITA, ETC.)
- 16:48AUTOMATIC DOCUMENTATION GENERATION
- 19:10CONTRIBUTOR CONSENSUS
- 22:05GOOD RECORDS
- 26:28LET'S GO REVIEW ALL THE DOCS
- 28:02USER-TRIGGERED REVIEW/UPDATE
- 29:34METRICS-DIRECTED REVIEW
- 33:11GRAND UNIFIED THEORY OF DOOS MAINTENANCE
related talks
35mLong-term Documentation Maintenance
44mPushing documentation (so it doesn't hurt anymore)
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
44mCreating a Culture of Documentation
18mContinuous Documentation Manifesto
36mTo document, or not document that is the question
40mDocumentation as User Experience
14mdocs docs docs