Contemporary Documentation
summary
A claim that documenting intent belongs in the version control and project management workflow comes with concrete practices: commit message templates, PR checklist, and linking commits to issue trackers so motivation travels with code. Examples include using issue templates, commit linting, automated cross-links and annotated tags, and a small script or CI check that enforces descriptions. Outcomes reported are immediate discoverability of why things changed and fewer mysteries in six months, with concrete steps to adopt tomorrow.
AI-written summary · about
chapters (9)
- 0:00Start
- 9:38TEAMS CHANGE
- 16:01COMMIT MESSAGE
- 20:33CODE REVIEW
- 22:37ASK A LOT OF QUESTIONS
- 23:29STORIES & TASKS
- 24:15How to reproduce?
- 25:17WRITE IT DOWN
- 25:32DOCUMENTATION WORKFLOW
related talks
34mDocumenting the (Ancient) History of Your Project
18mContinuous Documentation Manifesto
29mDocumentation Tradeoffs and Why Good Commits Matter
09mTelling stories through your commits
19mBuilding Trust Across Teams Through Documentation
40mDocumentation as User Experience
36mCommit Messages to the rescue!
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?