Communitygithub.com

lguidolin/recording-decisions

Use when a design or architecture decision has been made and needs to be captured — writing a decision record or ADR, updating a decision index, noting a deferred idea, or superseding a past decision. Keywords — ADR, decision record, rationale, rejected alternatives, dependency index.

recording-decisions 是什么?

recording-decisions is a Claude Code agent skill that use when a design or architecture decision has been made and needs to be captured — writing a decision record or ADR, updating a decision index, noting a deferred idea, or superseding a past decision. Keywords — ADR, decision record, rationale, rejected alternatives, dependency index.

兼容平台Claude Code~Codex CLI~Cursor
npx skills add https://github.com/lguidolin/agent-skills/tree/main/skills/recording-decisions

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

Recording Decisions

Overview

Decisions are durable infrastructure; memory and chat history are not. The cost of a record is paid once; the cost of a lost decision is paid every time someone reverse-engineers intent from code.

The Record Shape

Every non-trivial decision produces a record with a fixed structure, so any reader knows where to look:

SectionContains
ArchitectureThe shape of the solution and the key files
Data ModelEntities, fields, relationships
Decisions (with WHY)Each choice paired with its rationale — why is mandatory
InterfacesHow other code uses this
ConstraintsWhat must remain true
GotchasNon-obvious traps for the next person
Rejected AlternativesWhat was considered and discarded, and why — prevents relitigating settled questions

The Three Companion Artifacts

  • An index of all decisions with explicit dependency tracking (which builds on which) and a superseded section. Turns a pile of records into a navigable graph.
  • A "Future Considerations" doc — deferred ideas and known concerns, consulted when starting new work so nothing is silently forgotten. Incident action items and deferred-with-trigger decisions land here.
  • An archive — superseded records move here rather than being deleted. History is preserved, not overwritten.

Quick Reference

  • Record location convention: docs/superpowers/decisions/YYYY-MM-DD-<topic>.md with YAML frontmatter (title, date, component, status, supersedes, dependencies).
  • Future Considerations lives at docs/superpowers/future-considerations.md. Each entry carries a status (open / triggered / done / dropped) and, where it applies, the trigger that should reactivate it. Consult it when starting new work.
  • Frontmatter feeds the auto-generated index — keep it accurate.
  • The why and the rejected alternatives are the two highest-value sections. A record without them is a landmine.
  • Write the record at the Record stage of the pipeline (see designing-before-building), after Execute.

Bundled Tooling

This skill ships its own scripts and template, so they work in any repo the skill is installed into. They live next to SKILL.md:

recording-decisions/
  scripts/doc-archive.sh      find specs/plans lacking a decision record
  scripts/index-rebuild.sh    regenerate the index from record frontmatter
  templates/decision-record.md

Locate them — the skill may be installed per-project or globally:

for base in .claude/skills ~/.claude/skills; do
  d="$base/recording-decisions/scripts"
  [ -d "$d" ] && echo "$d" && break
done

doc-archive.sh [specs_dir] [plans_dir] [decisions_dir] [archive_dir] Lists specs with no matching decision record and prints a conversion prompt built from the template. Defaults to docs/superpowers/{specs,plans,decisions,archive}.

index-rebuild.sh [decisions_dir] [output_file] Rewrites docs/superpowers/index.md from every record's frontmatter — an Active table (component, title, date, dependencies) and a Superseded table (component, title, superseded by). Regenerated wholesale, so never hand-edit it.

Both are dependency-free bash: a project using this skill does not need yq, jq, or a task runner. If the scripts are missing, the procedures above are self-contained — do the work directly.

Why this matters for context

Specs and plans are verbose on purpose; they are written for a human following the reasoning. That verbosity is charged to context every time Claude opens one. A decision record keeps what is needed to move forward — decisions, the why, interfaces, constraints, gotchas, rejected alternatives — in ~30-50 lines, while the original spec moves to archive/ where it stays readable for humans and costs nothing until deliberately opened.

When NOT to use

Trivial, self-evident changes don't need a record. The test: would someone later ask "why was this done this way?" If yes, record it.

Full rationale: Article II of the constitution, bundled at engineering-constitution/references/engineering-constitution.md.

Individual skills in this repo

This repo contains 18 individual skills — each has its own dedicated page.

lguidolin/change-hygiene-and-code-craft

Use when writing or refactoring code, structuring a commit or PR, or deciding whether to abstract duplication. Symptoms — mixing reorg with logic changes, a PR doing several things at once, a file growing large, the second copy of similar code, or unsure whether to DRY something up.

lguidolin/cloud-delivery-aks

Use when deploying to Kubernetes or Azure Kubernetes Service (AKS), configuring cloud secrets, setting up progressive rollout/canary, per-PR ephemeral environments, or k8s health probes. Keywords — Kubernetes, AKS, Key Vault, Argo Rollouts, Flagger, canary, blue-green, liveness, readiness, PodDisruptionBudget, HPA, rollback, GHCR.

lguidolin/commit-history-rewrite

Use when an existing repository has messy commit history that needs to conform to conventional commits before adopting release-please, or when intermediate WIP/fixup/merge commits need to be cleaned up.

lguidolin/conventional-commits-and-releases

Use when committing, writing a commit message, opening a PR that will be squash-merged, or configuring automated versioning/changelogs. Keywords — conventional commits, release-please, semver, feat/fix/chore, breaking change, changelog.

lguidolin/defense-in-depth-security

Use when handling untrusted input, secrets, authentication/authorization, or dependencies — or threat-modeling a new surface. Keywords — STRIDE, threat model, least privilege, secrets management, supply chain, dependency scanning, input validation, audit log, defense in depth.

lguidolin/designing-before-building

Use when starting a feature, fixing a non-trivial bug, or about to write implementation code — before any code exists. Symptoms you need this: "this is simple, I'll just code it", reaching for the editor before a design is approved, or an idea that hasn't been turned into a spec and plan.

lguidolin/engineering-constitution

Use when starting work in a project that follows the engineering constitution, orienting to its rules, or deciding which engineering practice applies to a task — spec writing, commits, testing, security, deploys, database, or UI work.

lguidolin/graphql-contract-testing

Use when writing a GraphQL query/mutation that the UI and a test will share, or building route/schema contract or smoke tests. Symptoms — copying a query into a test, a test asserting on query text, schema change that didn't break the UI build, or RLS/permission drift. Keywords — graphql-codegen, typed document, contract test, route smoke test.

lguidolin/init-repo-CI

Use when setting up a new repository with conventional commits, release-please, and CI automation, or when retrofitting an existing repository that lacks automated versioning and PR validation workflows.

lguidolin/interface-craft-and-accessibility

Use when building or styling UI — components, layouts, forms, design tokens — or making accessibility decisions. Keywords — a11y, WCAG, keyboard navigation, focus state, contrast, design system, minimalist UI, component reuse, ARIA, semantic HTML.

lguidolin/merge-gates-and-automation

Use when setting up or changing CI, pre-push hooks, or a task runner, or deciding what must pass before merge. Symptoms — tempted to put authoritative checks only in a local hook, skip CI, bypass with --no-verify, or unsure what gates a merge vs. runs locally.

lguidolin/observability-and-slos

Use when adding logging, metrics, tracing, health checks, SLOs, or alerting — or when building a service surface that needs to be operable and debuggable. Keywords — structured logs, OpenTelemetry, correlation id, RED metrics, liveness, readiness, SLI, SLO, error budget, alerting.

lguidolin/performance-and-scale

Use when working on hot paths, list endpoints, pagination, data-access in loops, or public interfaces/schemas. Symptoms — unbounded queries, N+1 access, no latency budget, optimizing without measuring, or changing an interface many consumers depend on. Keywords — pagination, N+1, Hyrum's Law, performance budget, bundle size.

lguidolin/postgres-postgraphile-rls-and-sql

Use when writing PostgreSQL, PostGraphile config, Row-Level Security policies, SQL schema files, or working on the Browser→App→PostGraphile→Postgres data path. Keywords — RLS, SECURITY DEFINER, search_path, pgSettings, grants, roles, GraphQL depth limit, query cost, statement_timeout, SQL file organization.

lguidolin/resilience-and-deploy-safety

Use when planning a deploy, designing a rollback, or responding to an incident or writing a postmortem. Keywords — deploy safety, rollback, immutable artifact, progressive delivery, canary, blast radius, incident response, blameless postmortem, error budget.

lguidolin/ship-it

Use when the user wants to ship work — push, PR, archive decision records, merge, and clean up. Handles the full lifecycle from committing final changes through post-merge cleanup including converting specs/plans to compact decision records.

lguidolin/tests-as-a-control

Use when writing or modifying tests, when a test breaks during a refactor, or when testing permission/role rules. Symptoms — tempted to edit a test to make it pass, testing only the happy path, a deny-test that started passing, flaky tests, or unsure what to assert.

lguidolin/zero-downtime-migrations

Use when changing a database schema where data must survive the change — adding/removing/renaming columns, constraints, indexes, or backfilling. Symptoms — a destructive migration bundled with a code deploy, a NOT NULL column with a backfill, a table-locking UPDATE, or a rename. Keywords — expand/contract, parallel change, backfill, NOT VALID, CREATE INDEX CONCURRENTLY, graphile-migrate.

相关技能