Lightning Talk:Technical Documentation is like a Jigsaw Puzzle
summary
Technical documentation uses the same steps as assembling a jigsaw: sort by content type (conceptual, reference, procedural) and by reader goals, then build an outline like an edge pieces/frame (overview, prerequisites, step‑by‑step procedure), write the easy sections first (procedural steps often come fastest), and always get a second pair of eyes for editing. The claim: treating docs as organized pieces speeds production and reduces rework; practical method used at LaunchDarkly and tested on many real docs.
AI-written summary · about
chapters (11)
- 0:00Start
- 0:13Overview of the Agenda
- 1:13How Are Technical Documents like Jigsaw Puzzles
- 1:42Sorting and Organizing
- 2:11Content Type
- 2:23Technical Documentation Content Types
- 2:48Procedural Documentation
- 3:05Readers Goals and Needs
- 3:27Create an Outline
- 3:49Outline
- 4:13Procedural
related talks
01h 24mWriting Documentation - Practices and Theory
34mDocumentation Thinking Beyond the Docs: Lessons from Decision-Facing Technical Writing
10mWriting effective documentation
28mImproving Your Documentation: A talk for developers who want to write stuff good
33mWhat The Doc?!?! How to Write and Read Documentation That Allows You To Get Sh*t Done!
29mTaking Stock of Your Documentation
37mTaking a step back: Analysing your documentation
30mTechnical Documentation