We're Agile, we don't do documentation - Birgitta Boeckeler - Codemotion Amsterdam 2017
•
3 likes•971 views
In Agile, we value “working software over comprehensive documentation” - there is value in documentation, but we value working software more. This helps us get things done and avoid waste. However, extremes are very common: teams who avoid documentation altogether (“our code is self-documenting”), or teams who create way too much documentation. This talk will cover how to leverage documentation to improve team documentation, align everybody to a common vision, as well as underutilised forms of documentation that go beyond drawing the current system state.
Recommended
Recommended
More Related Content
Similar to We're Agile, we don't do documentation - Birgitta Boeckeler - Codemotion Amsterdam 2017
Similar to We're Agile, we don't do documentation - Birgitta Boeckeler - Codemotion Amsterdam 2017 (20)
More from Codemotion
More from Codemotion (20)
Recently uploaded
Recently uploaded (20)
We're Agile, we don't do documentation - Birgitta Boeckeler - Codemotion Amsterdam 2017
- 1. “WE’RE AGILE, WE DON’T DO DOCUMENTATION” Birgitta Böckeler | @birgitta410 AMSTERDAM 16 - 17 MAY 2017
- 3. “Documenting Software Architectures – Views and Beyond” 2nd edition, 2011; Clements, Bachmann, Bass, Garlan, Ivers, Little,Merson, Nord, Stafford
- 12. WHERE ARE YOU? 1:1 UML diagrams No documentation at all “Self- documenting code” Tests are readable specification
- 14. For the sake of a PROCESS.
- 18. The wall of COMMON UNDERSTANDING. Containers& Tech Stack Environments Components … … … Up for grabs!
- 20. INFO GRAPHICS. … … … Data schema migrations Synching behavior … Design of storage module
- 21. INFO GRAPHICS.
- 22. “WIDGET” KITS.
- 23. Create EMPATHY.
- 24. Empathy between TECH DECISION MAKERS and developers.
- 25. “Working on software without guidance, without documentation, is anxiety-producing” https://medium.com/@duretti/no-flex-zone-empathy-driven-development-aebf4d8cf7cf Empathy with EACH OTHER.
- 26. Empathy between PRODUCT PEOPLE and developers.
- 27. Help our FUTURE SELVES make informed DECISIONS.
- 28. Architecture DECISION records. http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions “Without understanding the rationale (…), only two choices: 1. Blindly accept the decision. 2. Blindly change it.”
- 30. LIGHTWEIGHT architecture DECISION records. “Things that are hard to change” https://martinfowler.com/ieeeSoftware/whoNeedsArchitect.pdf IEEE Software, 2003
- 38. Help our FUTURE SELVES make informed DECISIONS. Surface and understand COMPLEXITY. Create COMMON UNDERSTANDING. CREATIVE problem SOLVING. Create EMPATHY.
- 39. But how do we keep it UP TO DATE?!
- 40. @kaeff
- 41. As LITTLE as possible. Make it VISIBLE. Include in RITUALS.
- 44. <> Code THE TRUTH HOW-TOs • READMEs • Troubleshooting • Onboarding Checklist • … HISTORY • Decision logs • Spikes • Git history • … MAPS • System overviews • Complex things • For tourists/non-coders • …
- 45. Create ownership by collaborating on documentation. Constrain the space. Constantly groom it. Build that into your rituals. More hand, less mouse. It’s ok to have ephemeral documentation.
- 46. Documentation is about much MORE THAN conveying INFORMATION.