-
Adr vs readme vs changelog
Adr, readme and changelog are the most valueable pieces of documentation that a project could? / should? maintain. They provide us with crucial, core informations we need to star and continue effective development. Let us look at them closely. Usually we can keep everything in plain text or better yet use a Markdown format. You can even try and use some linter, highlgihts for easier writing. ADR (Architectural Decision Record) ADR (Architectural Decision Record): Document that holds a single, significant architectural decision. Includes the context, options that were considered, chosen solution with consequences. Serves as a traceable rationale for future reference as well as new team members. Readme txt or…


