madr
log4brains
madr | log4brains | |
---|---|---|
6 | 6 | |
1,352 | 1,062 | |
1.8% | - | |
6.8 | 0.0 | |
8 days ago | 4 months ago | |
TypeScript | ||
GNU General Public License v3.0 or later | Apache License 2.0 |
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?
log4brains
-
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.
-
Can't bring myself to produce code any more, any ideas to help?
I'm a solution architect in my current job, and I love it because I still get to solve technical problems and help/mentor more junior developers but I don't really write code anymore (except on minor occasions and it's mostly by choice). The tradeoff is I have to write docs and make presentations, but I learned how to do that easily enough.
- Build some good documentation habits in your team with ADRs (Architecture Decision Records) and their go-to tool: Log4brains
- Document your project by logging your decisions chronologically with ADRs (Architecture Decision Records)
- Log4brains: Document your projects by logging your decisions chronologically with ADRs (Architecture Decision Records)
- Document your projects by logging your architecture decisions chronologically with ADRs (Architecture Decision Records)
What are some alternatives?
architecture_decision_record - Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
adr-tools - Command-line tools for working with Architecture Decision Records
vscode-front-matter - Front Matter is a CMS running straight in Visual Studio Code. Can be used with static site generators like Hugo, Jekyll, Hexo, NextJs, Gatsby, and many more...
documentalist - :memo: A sort-of-static site generator optimized for living documentation of software projects
mdSilo-app - Lightweight Knowledge Base and Feed Reader.
mm-docs-template - Template to use with mm-docs
prpl - Lightweight library for building fast static sites
slant - Beautiful static documentation for your API
lineage - Generate beautiful documentation for your data pipelines in markdown format
ts-doc-gen-md - Generates documentation in github flavored markdown for typescript libraries.
como-documentar-seu-projeto-backend - 📕 Guia de como criar uma documentação para seu projeto Backend