Uncharted waters: Documenting emerging technology
summary
Documents early-stage container and OpenShift middleware projects before writers arrive, showing that writing requires 1–2 month lag catch-up, hands-on access to a deployed environment, and building install-and-use playthroughs. Recommends 12–20 step walkthroughs, tech notes, strict commit messages, checklists, pre-release audits and tracking docs as part of issue/workflow. Uses live demos, ASCII cinema and screenshots pragmatically; warns screenshots age fast and audits of the docs set are essential as features stagger across multiple releases.
AI-written summary · about
chapters (13)
- 0:00Introduction
- 0:24What is this talk about
- 1:26Development mindset
- 2:47Downstream documentation
- 4:15Constraints
- 7:24Gaming
- 7:47Takehome advice
- 9:17Multiple versions
- 12:26Interactive
- 13:10Live demos
- 14:39Screenshots
- 15:32Ducks
- 16:36More notes
related talks
45mDocs or it didn't happen!
29mMove Fast and Document Things: Writing internal docs at fast-moving organizations
29mTaking Stock of Your Documentation
37mTaking a step back: Analysing your documentation
56mEffective Documentation: The Key to Open Source Growth
20mDo Docs Better: Practical Tips on Delivering...
44mPushing documentation (so it doesn't hurt anymore)
39mThe Documentation Dream: One Team, No Silos, Shared Goal