record

Solid

Keep durable architecture decisions and product specs in sync with the work happening in the conversation. AUTO-INVOKE when a request establishes or changes a long-lived architectural boundary, public contract, data ownership rule, operational invariant, or repo-wide convention with meaningful alternatives. Also invoke on explicit triggers: "record this", "create an ADR", "document this decision", "update the spec", "ADR for X". Run BEFORE coding when the decision is upfront, or AFTER landing when the right call only became clear during implementation. Do not create ADRs for simple features, local implementation choices, routine dependency changes, or bug fixes that do not establish a durable rule.

Code & Development 494 stars 68 forks Updated today AGPL-3.0

Install

View on GitHub

Quality Score: 87/100

Stars 20%
90
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Record Knowledge Record architectural decisions for future reference, and keep related feature specs in sync. ## Record a decision When a significant architectural or design choice is made, create an ADR: 1. Choose a decentralized ID in the form `YYYY-MM-DD-short-title`. The short title must be specific enough to remain unique among decisions created on the same date. 2. Confirm that `docs/decisions/<id>.md` does not already exist. 3. Create `docs/decisions/<id>.md` using the template below. 4. Update `docs/decisions/INDEX.md` with the new entry. 5. **Reconcile specs** — see "Update or create a spec" below. Existing numeric ADR IDs remain valid and must not be renamed. References use the complete stable ID, for example `ADR-2026-07-16-project-shell-output`. ### ADR template ```markdown # ADR-YYYY-MM-DD-short-title: Short Title **Status:** accepted | superseded by <adr-id> | deprecated **Date:** YYYY-MM-DD **Area:** backend | frontend | infra | protocol | workflow ## Context What situation prompted this decision. 2-5 sentences. ## Decision What was decided. Reference file paths, packages, interfaces. ## Consequences Trade-offs. What becomes easier or harder. ## Alternatives Considered What else was considered and why it was rejected. ``` ### What warrants an ADR Create an ADR only when all of these are true: - The choice establishes a durable constraint, boundary, contract, ownership rule, operational invariant, or repo-wide convention. - There were meani...

Details

Author
kdlbs
Repository
kdlbs/kandev
Created
6 months ago
Last Updated
today
Language
Go
License
AGPL-3.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category