Rethinking your how-tos: From instructions to solving user problems
summary
Kong restructures how-tos into one template with prerequisites, runnable code snippets, an explicit final validation step, and in-line third‑party setup (Docker, HashiCorp Vault, Terraform, declarative config) so users can copy paste end to end. A headless-browser in-house test runner extracts snippets and uses tools like cucumber playright doc detective to run them; tests run as a GitHub Action and surface regressions before users see them. Outcomes include automated docs checks and 91% correct answers from the site chatbot (up from 84%).
AI-written summary · about
chapters (10)
- 0:00Introduction
- 1:05Documentation pain points
- 5:18Content types and frameworks
- 9:09New how-to template
- 11:40Test products as a writer
- 14:49Demo of how-to guide
- 17:20Deconstructing how-to formula
- 21:41Automated docs tests
- 24:28Measuring success
- 25:54Recap and key takeaways
related talks
48mUseful and Beautiful Developer Docs and How to Create Them
35mThe Art of Documentation and Readme.md for Open Source Projects
47mThe Art of Documentation and Readme.md
43mUseful and Beautiful Developer Docs and How to Create Them
26mTales from the QA Crypt
19mWhere Docs, Cloud-hosted Interactive Tutorials and CI Testing Intersect
45mUseful and Beautiful Developer Docs and How to Create Them
40mFrom resistance to adoption: navigating the challenges of docs-like-code