3 ms·
It depends on the exact problem and how long term you need to documentation to exist. For a lot of things physically drawing out diagrams is great. It's fast to
by fundamental 8y ago
It depends on the exact problem and how long term you need to documentation to exist. For a lot of things physically drawing out diagrams is great. It's fast to do and based upon the questions you get it's easy to draw more detail on the area being discussed.
For more long form docs I tend to use a mix of LaTeX's TiKZ (though I used to use PSTricks) for block diagrams and for a somewhat faster workflow I've used some of the diagramming tools which integrate nicely into an asciidoc based document. That can be graphviz, blockdiag, seqdiag, etc ( https://asciidoctor.org/docs/asciidoctor-diagram/ https://asciidoctor.org/docs/asciidoctor-diagram/ has a decent list of some of the options).
With any option it's easier to quickly sketch something out than it is to have some clear well organized diagrams which don't need any external context to understand.
- jayliew 8y agoSomething long term, that you can use to onboard new employees. They can just look a the visual and reconstruct a mental map of how things are laid out at a high level, without this institutional knowledge having to be passed around verbally and subject to the quirks of human memory (and subject to individuals possessing this knowledge potentially leaving the team!)