arc42 - Version 7

(for DE see below)

English Version

Finally, after extensive discussions with users and our committers we released a new version of arc42. Fully compatible with prior versions, preserving the established template structure, v7 has become even more pragmatic and compact. That makes using the new version simpler and more efficient than ever before. For v7 we vastly improved documentation and explanation of arc42 - creating two extensive sites (docs.arc42.org and faq.arc42.org). For a more detailed intro, see this post on the innoQ blog.

Deutsche Version:

Endlich, nach langer Diskussion mit Nutzern und Comittern haben wir eine neue Version von arc42 veröffentlicht. V7 ist vollständig kompatibel mit früheren Versionen. Wir haben die bewährte Struktur komplett erhalten, sämtliche Erklärungen und Hilfetexte jedoch gründlich überarbeitet und noch pragmatischer und einfacher gestaltet. Die Nutzung dieser neuen Version wird damit noch einfacher, als das bisher war. Insbesondere gibt es nun zwei umfangreiche Websites mit praktischer Hilfestellung ((docs.arc42.org and faq.arc42.org). Mehr Infos in diesem Post (im innoQ Blog).

FAQ for Software Architecture Documentation (with arc42)

I'm currently working hard on translating our German book (see this post) - which will be named "Communicating Software Architectures - lean, effective and painless documentation"). It's already on Leanpub, my favorite eBook publishing platform.

FREE in various formats

As arc42 is deeply rooted in open-source, I decided to extract the FAQ-section (frequently asked questions) from that book and make it available for free. As mentioned above - translation is not yet finished, and many of the questions in the FAQ collection have a "t.b.d" tag attached... but I'm quite positive I'll have the whole stuff translated until December 31st 2016.

Many categories of questions

I organized the (currently more than 100) questions in the following categories:

• A General questions
• B Questions on methodology
• C Questions on arc42 sections
• D Questions on modeling
• E Questions on arc42 and agile methods
• F Questions on tools for arc42
• G Questions on arc42 and versions / variants
• H Questions on arc42 and Traceability
• J Questions on managing documentation
• K Questions on customizing arc42

Your input is welcome

If you encounter questions around architecture documentation in general or arc42 in particular, let my know: DM me on our new @arc42Tipps Twitter account or email me on info-at arc42.de. By the way: I'm very grateful to innoQ for supporting arc42.

arc42 in Software-Engineering Radio Podcast

My innoQ-fellow-colleague, Eberhard Wolff, interviewed me about arc42 for the well-known podcast "Software Engineering Radio"... We discuss how documenting architecture fits into agile processes and how to find the right amount of documentation for a system. I briefly explain the different parts of the arc42 template covering requirements and the context of the system and the solution structure, including building blocks, runtime, and deployment. Finally, we cover tooling, versioning, testing documentation, and how to keep documentation up to date.

Praktische Tipps für arc42

arc42 hat sich als de-facto Standard für die Dokumentation von Softwarearchitekturen etabliert, zumindest in der D-A-CH Region. Schon länger gab es online diverse Beispiele, seit März diesen Jahres habe ich gemeinsam mit Michael Simons und Stefan Zörner dazu ein eBook veröffentlicht (als LeserIn dieses Blogs erhalten Sie bis Ende 2016 ganze 42% Rabatt!).

...in Aktion

Aber DAS wollte ich hier gar nicht in den Fokus rücken - vielmehr sollen konkrete Tipps zur Anwendung von arc42 zur Sprache kommen: Schon seit Jahren unterstütze ich Unternehmen unterschiedlicher Branchen und Größen beim Einsatz von arc42 in Entwicklungs- und Wartungsprojekten. Dabei konnte ich eine Vielzahl von Tipps und Ratschlägen sammeln - die nun endlich mal in gesammelter Form (als Buch) verfügbar sind. Peter Hruschka hat aus seiner vielfältigen Erfahrung, häufig aus Embedded und RealTime Umfeldern, kräftig beigesteuert, so dass wir auf insgesamt 200 Tipps rund um den Einsatz von arc42 gekommen sind. Ob es um arc42 in agilen Umfeldern geht, oder um die Anwendung in besonders großen (oder besonders kleinen) Systemen - stets liegt der Fokus auf praktischer Anwendbarkeit und Angemessenheit.

... Advent kommt bestimmt

Auf arc42 veranstalten wir ja regelmässig Aktionen, bei denen wir unseren LeserInnen kleine Geschenke versprechen. So viel sei hier verraten: Die Advents-Aktion 2016 hat etwas mit diesen Tipps und dem obigen Literaturhinweis zu tun... Es lohnt sich daher, gegen Jahresende ab-und-zu mal auf der Website vorbei zu schauen (oder dem noch jungen arc42-Twitter Account zu folgen).

one last thing

Übrigens schreibt gerade auch Ralf Müller (einer der Committer bei arc42 und langjähriger Nutzer!) ebenfalls gerade ganz aktiv einen Blog zum praktischen Einsatz von arc42.

(unabhängiger) Artikel über arc42-Einsatz

In der dotnetPRO erschien vor einiger Zeit "Nie wieder planlos" - ein ausführlicher Überblick zum arc42-Template und dessen Einsatz in der Praxis - aus der Feder von André Krämer.

 

Seit heute ist dieser kostenfrei als download erhältlich - dank einer Sondergenehmigung der dotnetPRO-Crew :-)