Can we NOT do docs at the eleventh hour? Mmmmmaybe.
summary
Claim: make documentation part of estimates and put a documentation task on the pull request so PRs cannot merge unless the documentation task is done. Use docs-as-code tooling, templates and rubrics, have developers draft and tech writers review, and reserve writer capacity for larger white papers. Collect doc issues and treat documentation bugs like code bugs with planned time for fixes. Outcome: fewer last-minute panics and deployed docs, but measurable customer impact requires the feedback loop and doc metrics.
AI-written summary · about
chapters (5)
- 0:00Start
- 3:54Treat Document Code Bugs like Documentation Bugs
- 5:51Would I Recommend Docs Templates To Help Devs
- 6:23What To Expect from the Documents
- 6:46Tips for Motivating Devs To Write
related talks
45mEnsuring that Documentation is a First-class Citizen in OS Projects
37mTaking a step back: Analysing your documentation
27mThe art and practice of documentation triage
20mDo Docs Better: Practical Tips on Delivering...
44mPushing documentation (so it doesn't hurt anymore)
44mCreating a Culture of Documentation
24mWho Writes the Docs?
46mTechnically Speaking: Improve your code with documentation