Skip to content

armgit / memos

Public Imported from GitHub
0

Memos is an open-source, self-hosted note-taking app that brings your everyday thoughts together in a personal timeline. Your data stays yours, and you choose what to keep private or share.

1.3 KB
Raw Blame

Design Documents

A design document records a decision and the reasoning behind it. Source code, tests, and package README.md or doc.go files describe current behavior; a design document does not have to.

Lifecycle

  • Draft. A design that is not yet shipped in a tagged release may change freely, even after its code is merged. Keep it in step with the implementation until the release, because the design itself often changes while a feature settles.
  • Implemented. Once the feature ships in a release, set Status: Implemented and freeze the body. Do not edit it to track later code changes.
  • Amendments. When a later release changes a frozen design, add or extend a dated ## Amendments section at the end that states what changed and why. Leave the original body intact, so the original rationale stays readable. A change large enough to need its own rationale gets a new design document that links back to the one it replaces.

Index

Implemented and frozen: