Testing Documentation: Why So Technical?
summary
Documentation must explain the why and the how and show it works: X‑ray claims over 10 million users and handles 100 million test cases per month, docs live in Confluence and are fed from a ticket board, updates belong in the definition of done, and screenshots use numbered circles to match steps. Practical tools used today include ChatGPT and Grammarly for drafting and proofreading. Pages follow one concept per page, top‑down summaries first, examples and troubleshooting second, and review by peers or AI before publishing.
AI-written summary · about
chapters (12)
- 0:00Introduction
- 3:15What is X-ray and products
- 4:41Technical documentation problems
- 7:15Key features of useful docs
- 8:41Technical writer’s workflow
- 11:08Structuring a doc page
- 13:15Writing documentation challenges
- 14:40Making docs relatable
- 16:25Documentation dos and don’ts
- 18:53Invisible role of tech writers
- 22:45Better documentation takeaways
- 25:56Q&A
related talks
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
01h 24mWriting Documentation - Practices and Theory
40mDocumentation as User Experience
37mHumanising Your Documentation
38mDocs as Tests: A Strategy for Resilient Docs
37mKeeping trust: Testing documentation as part of a continuous integration process
30mTest Documentation: How-To and Common Mistakes
13mTechnical documentation – how can I write them better and why should I care?