Keeping documentation alive
On This Lesson 4 topics
This lesson is planned. The outline below lists the topics it will cover. The full lesson has not been published yet.
In this lesson
keep documentation current through delivery and hand it over cleanly.
Planned topics
- Assign owners per document and set update triggers: a design change, a new ADR, a release.
- Keep documents next to the work: in the repository or wiki the team already uses, with reviews that include docs.
- Review the pack at each phase boundary; retire what is no longer true.
- Handover to operations and future architects: a short reading order, a "how to find things" page, and open risks and decisions.
- Test it: can someone new answer common questions from the pack alone?
Draft outline details
Demonstration
a documentation health check: owner present, last reviewed within agreed period, links working, matches deployed reality; scored for each pack document.
Check your understanding
How do you test the pack at handover?
Show answer
Ask someone new to answer typical questions using only the pack.
Practice
Apply this lesson with the module's lab, exercises and quiz.
Marking a lesson complete is optional and you can undo it any time. Your progress stays in this browser.