Ask HN: How do you document complex software systems?

1

IcePanel

#Design Tools #Developer Tools #Software Architecture 35 social mentions

2

C4 model

The C4 model [0] provides a mostly sensible structure and techniques for representing pure software systems across different abstraction levels. For systems involving software and hardware, or other complex interfacing (both technology and bureaucracy) this starts to delve into the universe of systems engineering. There's a decent assembly of knowledge on that in the SEBoK [1]. As another commenter has already called out too, one of the most valuable sources of information is also _why_ a system is in its current form and _how_ that's changed over time. ADR's [2] really do a good job at nailing this for just about any scale. [0]: https://c4model.com [1]: https://sebokwiki.org [2]: https://adr.github.io.

#Flow Charts And Diagrams #Diagrams #UML 17 social mentions