Maintaining Documentation: Make It Easy!

on YouTube ↗38m

" summary

Redesign for TypeScript adds a command-line docs generator wired into CI and local workflows, with mandatory preview checks on every PR and a simple CLI for live previews. The workflow includes unit-test code examples and recommends Dockerized installation tests, plus ESLint TSDoc checks and contribution guidelines. After rolling this system out, documentation build failures caused by code changes drop to zero and user feedback submissions increase noticeably.

AI-written summary · about

" chapters (12)

1. 0:00Introduction
2. 0:20Why I love documentation
3. 0:40Research on documentation
4. 1:48Why documentation maintenance
5. 3:13Make the documentation process automated
6. 4:22Test code examples
7. 7:23Poor reproducibility
8. 9:50Documentation changes
9. 12:23Traceability
10. 20:07Low Task Priority
11. 25:22QA
12. 30:22SelfService Score

" related talks

• 47mEngineering DocumentationLorna Jane Mitchell · GOTO Copenhagen 2022
• 23mJSDocs: It's like TypeScript but without all that TypeScriptAustin Gil · Conf42 JavaScript 2022
• 42mEngineering DocumentationLorna Jane Mitchell · YOW! Melbourne 2022
• 47mDocumentation Is Fine, Don't WorryDamien Lucas · Devoxx France 2024
• 51mWriting the Darn DocsRaymond Camden · Open Source 101 at Home 2020
• 35mBuilding Docs like Code: Continuous Integration for DocumentationMason Egger · PyCon US 2020
• 46mSave a Dev, Write Documentation!Sarah Haim-Lubczanski · Devoxx France 2024
• 44mPushing documentation (so it doesn't hurt anymore)Markus Schlichting · Voxxed Days Ticino 2023