Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Architecture documentation is not just consumed by programmers/coders. I can't imagine showing Haskell (or something similar) to non-technical leadership or during an M&A process.

Know your audience. Frankly I would loath trying to decipher code when getting a high-level view of the architecture of a system during onboarding.



Architecture-as-Code is source code. It can be compiled/rendered to other forms, like diagrams. (Ideally I'd like sonething like CSS to control styling the diagrams in so that you could adjust rendering, even selectively hiding pieces that aren’t interesting to a particular audience, without touching the logical description.)

In a perfect world, the architecture description would also be part of the “working” source code, interacting with more normal program code (and/or IAC) specifying the concrete components, and playing a concrete role in building and deploying systems, so that the work that goes into architecture specs isn’t duplicated and the arcuitecture description doesn’t get out of sync with reality.


Yep. This.


I don't often show architecture diagrams to non technical people BUT I also definitely don't show most technical people this Haskell code. I also don't show them the PlantUML.

I show them the png image.


TFA isn't advocating consuming architecture diagrams as code, but creating them with code. Render them and you get back the same images as you had before.


he suggested generating plantuml diagrams from it, so you would use the image for onboarding. you'd only see the code if you were going to update the architecture




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: