Project Docs
6 notes
-
Architecture
Good architecture documentation answers one question quickly: "How does this system work, and w...
-
Changelog
A changelog is a human-readable record of the changes made to a project over time. It helps users un...
-
Decision Record Template
Copy this file into your docs/architecture/decisions/ directory, rename it with a sequential number...
-
Environments
Every project runs in more than one place. Documenting your environments removes ambiguity, reduces...
-
Project Spec
A project specification defines what you are building, why you are building it, and how you plan to...
-
Tech Stack
This document records the technologies used by the project and the reasoning behind each choice. Kee...