Quick Check
-
What should the "Purpose" section contain?
Reveal answer
One sentence describing what the workflow does and why it exists — not the technical details, but the actual business purpose. -
Why document "Key Steps in Plain English" instead of the technical module details?
Reveal answer
Because in six months you won't remember the technical implementation details, but you'll remember what the workflow was *supposed* to do. Plain English helps you quickly understand the intent, then you can dive into the technical details if you need to fix something. -
What's the "2am test"?
Reveal answer
Could you (or someone else) understand the workflow well enough to diagnose and fix a problem at 2am without context? If not, the documentation isn't complete yet.
Next: Lesson 3: Monitoring and Alerting →