I do do feel that this is an unsolved problem, because capturing structure, behavior and temporarily in any sort of meaningful visual drawing is difficult. Even structure itself alone with its deep nesting is complex to depict.
Ask HN: Is there a better way to document complex software architectures?
11–20 of 239 posts
Re: Ask HN: Is there a better way to document complex software architectures?
#12Well, you need to use an architecture modelling tool to work [efficiently] with architecture models. Here are some I know of: Sparx’s Enterprice Architect NoMagic’s MagicDraw Qualiware Achimate (the tool, not the standard) There are surely more out there. I know both Sparx and MagicDraw have the possibility to write your own custom plugins for the tool. If you are in a big enough shop that will become very handy at s…
To add to this: I highly recommend reading into INCOSE's standards and recommendations on SysML.
Start by going through one of their last talks: https://sdincose.org/rsvpmaker/state-of-sysml-2018-09-12/
Re: Ask HN: Is there a better way to document complex software architectures?
#13Man, it seems like you totally lost connection with technology. There is no value in an architect who doesn’t code (none, if you think otherwise you’ve worked too long in enterprises that don’t deliver enough value to stay relevant the coming years).
Just use whatever drawing tools you know and draw up your diagrams. Should never take you hours to draw them up. How complex are they? If they take you so long, you probably are documenting way too much or are using way too complex architectures.
I feel the solution to your problem is more in the application than the tools. Try moving towards architectures like micro services. KISS. Then use the time you’re freeing up to keep connected to your developers and write code.
Re: Ask HN: Is there a better way to document complex software architectures?
#14It's not a tool (though there is the Structurizr tool), I like the c4model: http://c4model.com
C4 provides an approach with multiple layers, which is good for talking about architecture at different levels with different people. I also happen to like the Container diagram approach.
Re: Ask HN: Is there a better way to document complex software architectures?
#15Dia/visio for general diagrams and ArgoUML/plantUML for sequence diagrams. I found that the only useful UML diagram is the sequence diagram, that really needs a dedicated tool to draw.
PlantUML has simple text markup to describe diagram. It's easier than drawing and it can be integrated in documentation and generated on the fly (sphinx, wiki, doxygen).
And last but not least, ascii diagrams with http://asciiflow.com/ . The ASCII art diagram is the only format that can be integrated flawlessly into any email or documentation.
https://en.wikipedia.org/wiki/ArgoUML https://en.wikipedia.org/wiki/Dia_(software) http://plantuml.com/
Re: Ask HN: Is there a better way to document complex software architectures?
#16I never knew architect was a thing in software.
Re: Ask HN: Is there a better way to document complex software architectures?
#17Take a look at cargo's contribution and architecture docs. [1] That project was hands down one of the easiest for me to get into and learn. I am a firm believer in a nice architecture document that points to interesting code sections. To date, I have never encountered a UML in the wild and been satisfied.
Re: Ask HN: Is there a better way to document complex software architectures?
#18Do you need hackers for hire? Do you need to keep an eye on your spouse by gaining access to their emails? As a parent do you want to know what your kids do on a daily basis on social networks ( This includes facebook, twitter , instagram, whatsapp, WeChat and others to make sure they're not getting into trouble? Whatever it is, Ranging from Bank Jobs, Flipping cash, Criminal records, DMV, Taxes, Name it, he will get the job done. He's a professional hacker. lucidionysus@gmail.com
Re: Ask HN: Is there a better way to document complex software architectures?
#19I never knew architect was a thing in software.
The title is commonly found in heterogeneous projects where software isn't the solo driver. Ex: embedded systems
Pretty much the title just describes a senior dev., who owns the software aspect of the project.
Re: Ask HN: Is there a better way to document complex software architectures?
#20maybe have a look at https://mermaidjs.github.io. it's markdown for diagrams