Docs Tools for OSS Maintainers
Talkat Open Source Summit Japan + AI_dev: Open Source GenAI & ML Summit + Automotive Linux Summit 2025 · 2025-12-08..12-10·
summary
A practical toolkit distilled from Google Season of Docs work with about 70 projects: a web-based Docs Advisor that maps resources and timelines into four paths (planless iteration, mini overhaul, heroic overhaul), a set of dozen archetypes (audit, migration, prototype, translation, etc.), onboarding checks like friction logging and README-first tasks, and a simple metrics rule: pick metrics that force a change. Guidance on LLMs: use for editing, not for replacing user research. All materials live on GitHub and in 200+ case studies.
AI-written summary · about
chapters (11)
- 0:00Introduction
- 2:03Understanding the 'I need docs' impulse
- 5:36Introducing Docs Advisor
- 8:05User needs research
- 11:40Docs project types
- 15:32Archetype details
- 18:40Avoiding pitfalls
- 22:13Onboarding writers
- 25:27Documentation metrics
- 26:53Resources for maintainers
- 29:45Q&A
related talks
33mOSS Documentation Workshop
37mTaking a step back: Analysing your documentation
29mMeasuring Documentation Success in Open Source
48mUseful and Beautiful Developer Docs and How to Create Them
45mDocs That Scale: Strategies for Sustainable Documentation in Open Source Projects
46mSave a Dev, Write Documentation!
31mMacGyvering your Docs
40mDocumentation Communities: Sound Strategy or Documentarian's Gambit?