mcpField
D
documenting-decisions

documenting-decisions

github.com/pandoscopeDevelopment11.9k installsUpdated 5w ago
Repository

About documenting-decisions

A skill for recording consequential development choices in code and summarizing them for review. It helps developers and coding agents distinguish review-worthy decisions from routine changes, with guidance for ADRs and ticket reconciliation.

Key features

  1. 01Six decision checkpoint tags
  2. 02Decision log for pull requests
  3. 03ADR follow-up guidance
  4. 04Ticket reconciliation after completion
  5. 05Diff hunk classification mode

Use cases

  1. 01Flagging architecture or interface changes
  2. 02Summarizing security and irreversible changes
  3. 03Reviewing a diff by decision category

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/pandoscope/skills --skill documenting-decisions

After installing, type/documenting-decisionsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
references/
canary-signals.md
decision-markers.md
irreversible-operations.md
marker-examples.md
pre-approval-gate.md
scope-interpretation.md
security-protocol.md

Details

From the project README

Documenting Decisions

Checkpoint tags

TagWhen to mark
ARCHNew abstractions, deps, data models, component boundaries — anything that shapes long-term structure.
SCOPEYou resolved an ambiguity in the task by choosing an interpretation.
IFACEChanged a public API, config schema, CLI flag, env var, or wire format.
SECTouched auth, crypto, permissions, network exposure, or input validation.
IRREVCreated a migration, data deletion, deployment trigger, or external side effect.
NOVELNo existing repo pattern to follow — you interpolated from training data.

Do not mark routine changes (pattern-following, boilerplate, refactoring).

Format

See this skill's references/ decision-markers.md and (if needed) marker-examples.md.

After task completion

Generate decision log from markers in changed files and add to PR description:

## Decisions requiring review
- **TAG** `file:line` — explanation
## Routine (skip review)
[One-line summary]

If an ARCH or IRREV marker meets the writing-adrs bar (hard to reverse, surprising without context, result of a real trade-off), also write the ADR per that skill.

Reconcile driving ticket

Work driven by ticket → update it before close: fold in deviations, mid-session scope, decisions above (or their ADR/glossary refs). Per to-tickets reproducibility invariant: replayed issue stream builds final state, not first draft.

Diff classification mode

When user requests review of diff, classify each hunk as one of the six tags or ROUTINE. Present as File: path — TAG with line ranges.

Reference files

  • references/canary-signals.md — CI scripts for automated checkpoint detection (repo setup, not runtime).
  • references/marker-examples.md — example markers in multiple languages.
  • other files in references are only relevant if explicitly mentioned in AGENTS.md or requested by the user.

Comments

Markdown supported