Venue: innoQ event
Gernot Starke talks about arc42: an open-source set of templates he developed to document software architecture based on his practical experience with real projects. Also Gernot and host Eberhard then discuss how documenting architecture fits into agile processes and how to find the right amount of documentation for a system. They walk through the different parts of the arc42 templates covering requirements and the context of the system and the solution structure, including building blocks, runtime, and deployment. They discuss tooling, versioning, testing documentation, and how to keep documentation up to date.
Show Notes
Related Links:
- Gernot on Twitter: http://twitter.com/gernotstarke
- arc42 homepage http://arc42.org/
- arc42 examples http://arc42.org/page13/index.html
- arc42 templates http://confluence.arc42.org/display/LANDINGZON/landing+zone
- Gernot’s homepage (German) http://gernotstarke.de/
- Episode 228: Software Architecture Sketches with Simon Brown https://www.se-radio.net/2015/06/episode-228-software-architecture-sketches-with-simon-brown/
- Simon Brown’s homepage http://www.codingthearchitecture.com/
Michael Simons (Twitter: @rotnroll666) provided another example of arc42 in practice, for his biking application:
http://biking.michael-simons.eu/docs/index.html
Stefan Zörner (Twitter: @StefanZoerner) has created a chess engine and documented it with arc42 (in German…):
http://dokchess.de/dokchess/arc42/index.html
[…] Le caratteristiche di Arc42 vengono spiegate in questa intervista su Software Engineering Radio. […]
Here is what I tell my peers in IT and business on documentation myths and what one can do about it.
1)Architecture documentation (any documentation for that matter) helps all projects – one man or 1000 man project. Agile or waterfall!
2) Documentation is a habit one should get into from the beginning. Excuses and temptations are plenty to skip documentation, overcome them!.
3) Documentation is not for non-technical staff, nor for dummies! Your work is not over until it is documented for future reference for maintenance!
4) Old habits die hard! Start with good habit! Document enough for the project – one page or 100 pages, you decide. This is ART!
5) Documents I created over many years were extremely helpful to me [yes, I find my documents extremly helpful after 1 year] and to others, saving bunch of time, $$$ and head ache!
6) Just Do It! Someone will thank you in future even if you are not around. Leave a great legacy!
Yes Arc42 is one template you can use!
[…] I have listened to a podcast Software Engineering Radio Episode 244: Gernot Starke on Architecture Documentation using […]