No Docs? No Problem! From Zero to Full Documentation in Less Time than You Think
summary
Turns a codebase with virtually no docs into a full set of internal and external references plus code‑integration and end‑user guides for HarfBuzz, documenting that HB_shape as the primary API drives a user manual while separate reference material serves integrators, mining mailing lists and the issue tracker for real questions, staging work into staged rollout units, automating builds and spellchecks in CI, treating docs as an alternative API, and delaying markup until prose and examples are stable (defer markup).
AI-written summary · about
chapters (20)
- 0:00Intro
- 1:03The Takeaway
- 1:19About Me
- 2:14What is HBShape
- 3:52Do you need documentation
- 4:21Documentation as an API
- 5:25Planning Phase
- 5:51Documentation is monolithic
- 6:13Target readers
- 12:45Documentation collection
- 14:08Documentation goals
- 19:30Writing tips
- 25:41Continuous integration
- 25:56Voice consistency
- 27:11External reviewers
- 28:46No Docs
- 29:36Testing
- 31:26Publishing
- 33:41Conclusion
- 34:26Questions
related talks
44mPushing documentation (so it doesn't hurt anymore)
39mDevelopers Documentation: your hidden strength
48mBeyond Words: Crafting User-Friendly Documentation
45mDocs or it didn't happen!
43mThe Docs Are Fine, Don't Worry
44mUseful and Beautiful Developer Docs and How to Create Them
51mWriting the Darn Docs
35mBuilding Docs like Code: Continuous Integration for Documentation