Documentation, it is alive!
summary
Covers modern alternatives to traditional software documentation, demonstrating concrete techniques like living documentation, test-based user stories/executable specifications readable to business, automated generation of documentation fragments, tools for creating diagrams without UML, and approaches to documenting APIs that avoid heavy Swagger annotation usage.
AI-written summary · about
chapters (12)
- 0:00Intro
- 0:34YOUR DOCUMENTATION
- 6:24AGILE TECHNIQUES
- 17:16SHANEFUL DOCUMENTATION
- 25:25IS PROGRAMMING ART?
- 27:53QUICKLY DRAW
- 31:37EXECUTABLE SPECIFICATIONS
- 32:54SPOCK REPORTS 13.0
- 38:58SPRING REST DOCS
- 40:25LIVING DOCUMENTATION
- 40:41CORE PRINCIPLES
- 45:59SUMMARY
related talks
05mWhy Living Documentation is Cool
50m"Living Documentation": When Our Product Definition, Our Automated Tests...
40mDocumentation as User Experience
51mDocumenting and Communicating Modern Software Architectures
47mDocumentation Is Fine, Don't Worry
35mDocumenting APIs: new era, same craft
37mHumanising Your Documentation
51mWriting the Darn Docs