3 ms·
I still see it used and use it myself. You sketch out simple diagrams of major modules and how they interact. That gives an understanding of what goes where a
by adriancr 6y ago
I still see it used and use it myself.
You sketch out simple diagrams of major modules and how they interact.
That gives an understanding of what goes where and how things interact at high level.
You dont detail each function/attribute/call/... you'd go insane and it would be useless / you'd lose your readers time. (If they want this level of detail they can check the code)
It's also useful when doing new big features where you need approval/feedback/advice. One simple class like diagram to show how you structured your code is generally useful for people you present it to to understand what you want. Some use cases like sequence diagrams are also useful. Then you detail out further in whatever is agreed in the company.
Sometimes its useful to describe flows for really complicated bugs with a sketch like sequence diagrams to make sure you undetstand and found actual root cause and to show that.