Live data from Hacker News

Documenting software architecture with arc42

innoq.com

21–30 of 34 posts

Re: Documenting software architecture with arc42

#21
Question. What tools are people using for architecture documentation besides Visio?

What's the most productive tool you've found?

I keep going back to Visio, but I really want a tool purpose designed for quick architecture diagrams that's more opinionated.

Visio is so open ended, to me, it feels only slightly more efficient than using Photoshop.

Re: Documenting software architecture with arc42

#22
post #21

Question. What tools are people using for architecture documentation besides Visio? What's the most productive tool you've found? I keep going back to Visio, but I really want a tool purpose designed for quick architecture diagrams that's more opinionated. Visio is so open ended, to me, it feels only slightly more efficient than using Photoshop.

Im using draw.io Just because it integrates Well to jira and confluence, But there really isnt much difference apart from license costs.

Re: Documenting software architecture with arc42

#23
I would say arc42 is quite recognized documentation framework among software architects in Germany. My team is working with one major German automotive group and we/they are using slightly modified arc42 to document architectural parts + requirements for one of their core sw platforms.

Also as far as I’m aware arc42 is a part of training courses for iSAQ certification for sw architects.

Re: Documenting software architecture with arc42

#24
I was prepared to be upset that this article is an almost word-for-word copy of the "overview" page on the arc42 website (https://arc42.org/overview). But then I saw that the author is one of the arc42 maintainers. Now I need to find another target for my righteous indignation.

Re: Documenting software architecture with arc42

#25
post #21

Question. What tools are people using for architecture documentation besides Visio? What's the most productive tool you've found? I keep going back to Visio, but I really want a tool purpose designed for quick architecture diagrams that's more opinionated. Visio is so open ended, to me, it feels only slightly more efficient than using Photoshop.

I'm using yEd, but that likely has the same issues as you mention, being very open-ended and requiring lots of micromanagement of styles and layouts. Perhaps you are seeking a tool such as plantuml in which you specify your diagrams textually and have them rendered by a compiler. It only supports a specific set of diagram types, primarily from the UML family, but I think it's also possible to install a third party C4 style.

Re: Documenting software architecture with arc42

#26

Many of my documents do indeed have a similar layout for design and it is nice to see efforts like this to create more rigor in SW architecture. As a practitioner (and being opinionated), I have these observations: - The "Building block view" is really the high level Structural Design. I tend to use structural decomposition to relay this information, iteratively breaking down into subsystems, components, etc. For thi…

As I was reading this I felt that it overlapped and complemented the C4 approach in a lot of places. There's even a superficial connection: C4 is contained in the title!

Agreed, the one thing I really think Simon [1] got right about visuals is the information they relay. Seeing a box diagram is one thing, e.g. boxes, arrows, names of tech (omg, @see AWS diagrams - they're really unexpressive deployment diagrams).

Compare that to a C4 Landscape or Context diagram - and its just night and day - so much more meaningful information and the ability to express not just structure, but to provide hints at data flows, actors, and externalities. In the end, I've found the most value for C4 in communicating architecture to upper management and new hires. These diagrams really make more sense than boxes and lines.

For arc42 I find the document content really appealing - its like engineering thinking. There is no standard template/model for design docs, perhaps this could start a baseline or trend to do something similar. I do still prefer Structural and Behavioral classifications.

[1] Simon Brown, creator of C4 https://simonbrown.je/

Re: Documenting software architecture with arc42

#27

They also mention ADR (architecture decision records). Even if it’s yet another fad, most companies I’ve worked for really needed a framework like this. I have only skimmed it so far but I’ll definitely talk to the managers and architects at my company about it. Any kind of formalization on this topic is greatly needed.

ADRs are more general purpose for documenting any kind of decision. This seems to be much more specific to a certain level of system architecture.

Re: Documenting software architecture with arc42

#28
post #21

Question. What tools are people using for architecture documentation besides Visio? What's the most productive tool you've found? I keep going back to Visio, but I really want a tool purpose designed for quick architecture diagrams that's more opinionated. Visio is so open ended, to me, it feels only slightly more efficient than using Photoshop.

draw.io - offers both online and offline modes, which is great.

Re: Documenting software architecture with arc42

#29

Many of my documents do indeed have a similar layout for design and it is nice to see efforts like this to create more rigor in SW architecture. As a practitioner (and being opinionated), I have these observations: - The "Building block view" is really the high level Structural Design. I tend to use structural decomposition to relay this information, iteratively breaking down into subsystems, components, etc. For thi…

As I was reading this I felt that it overlapped and complemented the C4 approach in a lot of places. There's even a superficial connection: C4 is contained in the title!

That‘s what we‘re doing and it works great. https://www.mytechiebits.com/ARC42 shows how the sections of Arc42 map to the C4 diagrams

Re: Documenting software architecture with arc42

#30
post #21

Question. What tools are people using for architecture documentation besides Visio? What's the most productive tool you've found? I keep going back to Visio, but I really want a tool purpose designed for quick architecture diagrams that's more opinionated. Visio is so open ended, to me, it feels only slightly more efficient than using Photoshop.

(I'm the author of the article)

I've written about requirements for docu-tools https://www.innoq.com/en/articles/2022/01/principles-of-tech...

In short: You need text + diagramming tools. Go as light as possible, start small (draw.io and Markdown/AsciiDoc). Use high-end modeling tools (like Enterprise Architect or ArchiMate only in larger teams and/or with formal documentation requirements (20+ devs). Have a look at docToolchain.

Post reply on HN