I created a CLI tool that can be used to create, update, list and export (to HTML) software design documents like Architecture Decision Records (ADR), Requests for Comments (RFC), and any other custom document types you may have.
It's already trivial to create a Markdown file from an existing template and start typing. And, you will have to do most of the job in your favorite editor anyway. Here is what talo brings to the table:
- You can list all your documents displaying their titles and latest statuses.
- You can export your documents to HTML. talo will link documents to each other so that when a document supersedes another, you will be able to navigate between the two via hyperlinks.
- You are not limited to ADR and RFC. You can create your own document type(s) and use talo to manage them.
The demo GIF in the README showcases some of the use cases. Advanced topics like creating your own document types are also documented in the README.
talo is free and open source.
If you already have .NET SDK 8.0, you can install it as a dotnet tool (dotnet tool install --global Canpolat.Talo). Otherwise, you can download the single file binary executable for your system (Linux/Windows).