Product & engineering
A handover doc for code nobody dares touch
- Time
- 29 min + 6 min
- What was said
- 2 sentences
- Delivered
- Handover doc, 9 risky spots
The finished work

How it got made
The repo in the workspace (the koa/ folder) is going to a new teammate to maintain, and there are a few places in it nobody has dared to touch. Read it thoroughly and write a handover doc: start with a module diagram that explains how the files work together and what a request passes through from coming in to the response going out; then pick out the few places that are easiest to break, and for each explain what it does, why it's written that way and what to watch out for when changing it (back it up with tests or commit history where you can); end with a checklist of things to watch when making changes. Deliver a properly laid-out HTML file (handover/index.html) for the new teammate to read in a browser, opening offline with no CDN, with file names and line numbers on the code snippets. Don't change any code in the repo.
Put the repo in the workspace and send that one sentence

29 min later: the doc, after running every test

One more sentence: add a section on fresh()

6 min later: the ninth section is in
