Skip to content

Comment on Ask HN: Are there any openly available software architecture documents?

Comments

ADR is made for this

https://github.com/joelparkerhenderson/architecture_decision...

There are multiple variants. Simple or detailed.

ADRs are great, and don't need to be overly formal or use tooling. We've been hand-writing Markdown-based ADRs (https://github.com/adr/madr) checked in with our code in a docs/adr directory.

You don't put every little decision in of course, but most projects have at least 1-2 areas where even the people involved with the decision have a hard time recollecting all the context for the decision.

The downside, at least for OP, is that they're usually something you capture at the time the decision is made - not when you're leaving a project.

AboutSource Built by g1lg1l

Hackerly is an independent reader for Hacker News, built on the public HN API. Not affiliated with Y Combinator.