madr
architecture_decision_record
madr | architecture_decision_record | |
---|---|---|
6 | 22 | |
1,352 | 11,264 | |
1.8% | - | |
6.8 | 7.7 | |
8 days ago | 3 days ago | |
GNU General Public License v3.0 or later | - |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
madr
-
Ask HN: How do you document engineering efforts?
MADR [1] in its reframed "Any Decision Record" form can be a good tool for that. RFDs [2] also appear to capture a similar intent.
[1]: https://adr.github.io/madr/
[2]: https://rfd.shared.oxide.computer/rfd/0001
-
Documenting your decisions using the ADR approach
Markdown Any Decision Records
-
A practical overview on Architecture Decision Records (ADR)
There is an interesting win-win tool called log4brains, that can turn your markdown into a static website. It's also integrated into MADR template. I haven’t had time to try them yet, but it's in my backlog.
- Stuck with crazy incompetent peer
-
The disproportionate influence of early tech decisions
It can be helpful to write down the context of why you made your decision, so that if/when you revisit it later it’s more clear. ADRs are one way to do this: https://adr.github.io/madr/
- How can I best deal with an engineer who disagrees with an architecture decision?
architecture_decision_record
-
Ask HN: How to Translate Markdown Repositories?
I'm translating the Architecture Decision Record project to more languages. I'm seeking advice and guidance please: how are you all managing translations of git repos of content such as documentation and markdown files?
My experiments so far are here:
https://github.com/sixarm/locale-help
My work-in-progress is to create a top level directory `./locales`, then subdirectories per language using a ISO 639-1 two-letter language code, then content directories, for example:
./locales/en/hello/ (this is in English)
./locales/es/hola/ (this is in Español a.k.a. Spanish)
What do you use to track which content directories correspond to each other across languages?
The Architecture Decision Record repo is now mostly auto-translated into Spanish, French, Welsh, and Korean, in the top level directory `./locales`, using the program `slug-case` to help translate the markdown content file headlines into directory names:
https://github.com/joelparkerhenderson/architecture-decision-record
-
Show HN: Architecture Decision Record – Spanish Tranlsations
Link is https://github.com/joelparkerhenderson/architecture-decision...
-
Architecture diagrams enable better conversations
Hi, article author here, we supplement our architecture diagrams with Architectural Decision Records (ADRs) https://github.com/joelparkerhenderson/architecture-decision... in the ADR we capture:
-
Documenting your decisions using the ADR approach
Architecture decision record by joelparkerhenderson
-
Polar v1.0: Let’s Fix Open Source Funding
If anyone wants to see Polar in action on a GitHub issue, I'm experimenting with Polar on my Architecture Decision Record repo:
https://github.com/joelparkerhenderson/architecture-decision...
(I'm on the fence about the value of Polar for this kind of issue... see what you think)
-
How did you acquire confidence in system design?
This method is only slightly formalized as ADR (architecture decision record). What I personally like about templates that people share on the interned (https://github.com/joelparkerhenderson/architecture-decision-record) it that if force designed to actually consider cons of selected approach or honestly attempt to analyze alternatives.
-
A practical overview on Architecture Decision Records (ADR)
The GitHub repo joelparkerhenderson/architecture-decision-record is a good source to get an overview of tools, articles and examples.
-
Ask HN: How to do Git successors, in case of death?
GitHub is prompting me to add a git successor to my open source repo, in case I die.
Do people here have advice about how to do this, or experience in doing it?
Any brainstorms about how to do it across all the related repos, orgs, etc., such as a will, or well-known file in the repo, that donates to a nonprofit, or foundation, etc.?
Here's the repo:
https://github.com/joelparkerhenderson/architecture-decision-record
-
A Simple Framework for Architectural Decisions
Architecture Decision Records are a big help for teamwork. I have a bunch of notes and examples here, including from my time at ThoughtWorks with technology radars.
https://github.com/joelparkerhenderson/architecture-decision...
-
Documenting agreements
If you want to get started with ADR, I recommend looking at the repository, where you can find different ADR templates and examples of how to use them.
What are some alternatives?
log4brains - ✍️ Log and publish your architecture decisions (ADR)
backstage - Backstage is an open platform for building developer portals
oasis-core - Performant and Confidentiality-Preserving Smart Contracts + Blockchains
danger-js - ⚠️ Stop saying "you forgot to …" in code review
arc42.org-site - (jekyll-based) website for arc42.org - the template for communicating software architectures.
rfcs - Specifications for Interledger and related protocols
architecture-decision
Bountysource - Bountysource is the funding platform for open-source software.
docker-flask-example - A production ready example Flask app that's using Docker and Docker Compose.
python-architecture-linter - Ensure that your projects are built the right way.
rfcs - RFCs for changes to Rust