Hacker News new | ask | show | jobs
by nicklarsennz 1529 days ago
I've found Lightweight Architecture Decision Records (as markdown docs in a repo with the code, or wherever makes sense) to explain the current landscape, options, decision, and foreseeable consequences. Keeping it really light makes it tolerable for people who don't like to write docs, though does need the team to insist on the doc for anything non trivial.

I also like using the Draw.io vscode extension to draw diagrams without having to export into a separate file or copy into the repo.

1 comments

I push for plantuml sequence diagrams for almost any new feature. Keep the files in SCC and can review with the MR.

Most engineers find them useful and not too much of a headache to write.

Back when I did these sorts of doc tasks for a prototyping team, I used to create BUML* using Visio. It was kind of hard but nowhere near as hard as using Rational's offering. The dev team liked and used them. I like the looks of PlantUML. Thanks for posting about it.

* Bastardized Universal Markup Language.