Rubric: L-DOCS-MODEL
Lens: L-DOCS-MODEL · Density: D-LOW (Top N) · Axes: RDB, OPS, CMP
Criteria
- Can a stranger form a correct mental model from README + architecture docs?
- Docs match code (CMP).
- Glossaries / domain language consistency.
- “How to change X” discoverability.
- Dangerous outdated docs (worse than none).
Citations
| Work |
Point |
| Divio documentation system |
Tutorials / how-to / reference / explanation |
| ISO/IEC 25010 |
Appropriateness recognizability / learnability |
| Write the Docs community practices |
Docs as product |
Pros / cons
| Pros |
Cons |
| Outdated docs are high-severity CMP issues |
Easy to demand encyclopedias — Top N keeps focus |
| Mental-model clarity predicts maintainability |
Opinionated doc style wars — cite Divio, don’t invent |