Plan + ADR Flow
Goal
Keep task planning and technical decisions documented in PLAN.md and docs/ADR/... before, during, and after implementation.
Workflow
-
Triage task size
- If the task is not meaningfully decomposable, proceed without creating
PLAN.mdor ADR unless requested. - If the task is decomposable, draft a plan and confirm with the user before implementation.
- If the task is not meaningfully decomposable, proceed without creating
-
Create plan and ADR when planning
- Create or replace
PLAN.mdat repo root with the implementation plan. - Create
docs/ADR/YYYYMMDD-title.mdfor the technical decision record before coding. - Create
docs/ADR/if missing. - Use a short, lowercase, hyphenated slug for
title.
- Create or replace
-
Update during implementation
- Treat
PLAN.mdas a living memo; update it frequently to reflect reality. - Append ADR updates when technical issues or new decisions appear; keep prior entries.
- Treat
-
Finalize after implementation
- Update ADR with outcomes, changes, and follow-ups.
- Mark
PLAN.mdas complete or reflect the final state.
ADR template (minimum)
# <Title>
Date: YYYY-MM-DD
Status: Proposed | Accepted | Superseded
## Context
- <Why this decision is needed>
## Decision
- <What is decided>
## Consequences
- <Impact, tradeoffs, follow-ups>
## Change log
- YYYY-MM-DD: <What changed and why>
Notes
- Keep ADR updates additive; never delete past entries.
- Keep
PLAN.mdspecific to the current task; do not modifyPLANS.mdunless explicitly asked.
微信扫一扫