Is a story implementation-ready? Checks clear acceptance criteria, open questions, ADR refs. READY/NEEDS WORK/BLOCKED/NOT ASSESSED.
复制下面这句话,粘贴给 Claude Code、Codex、Cursor 等 AI 编程工具,它会读取安装说明并在你确认后完成安装。
请阅读 https://ai.atlankj.com/install/asset/gh-story-readiness-8051a8380368 ,按照其中的说明把「story-readiness」安装到你(当前 AI 工具)中。执行前先告诉我将运行的命令和写入的位置,等我确认。
查看 AI 将读取的安装说明正在读取 GitHub 原文…
内容来自 GitHub 原始文件,由原作者维护。在 GitHub 查看
!bash "${CLAUDE_SKILL_DIR}/../../hooks/yaml-helper.sh" resolve_config --keys review_mode,automation,workflow,qa.level,testing.strict,system_overrides
Resolved above — use as-is; --review overrides review_mode. No block →
defaults in .claude/docs/config-resolution.md.
This skill validates that a story file contains everything a developer needs to begin implementation — no mid-sprint design interruptions, no guessing, no ambiguous acceptance criteria. Run it before assigning a story.
This skill is read-only. It never edits story files. It reports findings and asks whether the user wants help filling gaps.
Output: Verdict per story (READY / NEEDS WORK / BLOCKED / NOT ASSESSED) with a specific
NOT ASSESSEDis not a synonym forBLOCKED.BLOCKEDis a finding about the story — a Proposed ADR, an unresolved dependency — and it tells the reader exactly what to clear. UseNOT ASSESSEDwhen the story could not be evaluated at all: the file is unreadable or unparseable, or a referenced ADR or design document cannot be located, so the checks below cannot run. Collapsing that intoBLOCKEDreports a blocker that does not exist and hides the one that does — the reader chases a phantom ADR instead of a missing file.READYmust never be reachable for a story that was not actually evaluated.Precedence — first matching rule wins, in this order: BLOCKED, then NEEDS WORK, then NOT ASSESSED, then READY.
NOT ASSESSEDoutranksREADY(a story that could not be evaluated has not been shown ready) and ranks below both failure verdicts (a known blocker is more actionable than an unknown, and demoting it behind an access problem buries it). A story with both a real blocker and an unevaluable check isBLOCKED— the blocker is the actionable finding. This half of the rank has to be stated: the rule above establishes only thatREADYis unreachable, which would leave the ordering againstBLOCKEDto inference. gap list for each non-ready story.
See .claude/docs/director-gates.md for the full check pattern and mode definitions. Individual gate definitions live in .claude/docs/director-gates/[gate-id].md — the spawned agent reads its own gate file; do not read it in the parent session.
Every AskUserQuestion call follows .claude/docs/automation-modes.md
(collaborative asks always · guided major-only · autonomous logs and proceeds;
automation_always_ask categories always prompt).
Resolve the workflow tier per story (per .claude/docs/workflow-modes.md):
for the system a story belongs to (the GDD filename stem of its GDD: path;
the [system] segment of a TR-[system]-NNN ID is a fallback alias only), use the
system_overrides row for that system if the block lists one, else the
project value. When validating multiple stories (all / sprint scope),
resolve per story — different systems may sit at different tiers. The tier
sets which checklist sections block — see the note in Section 3.
qa.level: controls whether a test requirement is
validated. At minimal, the "Test evidence requirement is clear" item
auto-passes (no requirement validated); at standard, validate the per-type test
requirement (strictness from testing.strict); at full, also validate a
coverage target. Distinct axis from workflow.
Scope: $ARGUMENTS[0] (blank = ask user via AskUserQuestion)
/story-readiness production/epics/combat/story-001-basic-attack.md):
validate that single story file.sprint: read the current sprint plan from production/sprints/ (most
recent file), extract every story path it references, validate each one.all: glob production/epics/**/*.md, exclude EPIC.md index files,
validate every story file found.If no argument is given, use AskUserQuestion:
Report the scope before proceeding: "Validating [N] story files."
If the scope resolves to ZERO story files, stop and report
NOT ASSESSED — no stories in scope. Name which scope was searched and which path was empty (production/epics/**/*.md, the sprint file's story list, or the specific path given), and route:/create-epics [layer]then/create-stories [epic-slug].The zero-scope path is mandatory. Without it an empty glob falls through to the Section 5 aggregate template and renders
Ready: 0 / Needs Work: 0 / Blocked: 0above an empty list — indistinguishable from "I checked every story and none needed work". It is the core failure of this framework exactly: a scan that finds nothing because there was nothing to scan, reported the same way as a clean result. Three zeros read as a healthy sprint.Note what made this survive:
NOT ASSESSEDwas already in this skill's vocabulary, but the body scoped it to per-story evaluation failures (an unreadable or unparseable file, a missing referenced ADR). The verdict existed; the case that most needs it had no route to it. It is a recurring shape — a correct fix that did not reach one surface.A zero-story sprint scope is not the same as an absent sprint file. If
production/sprints/has no file at all, say that instead — "no sprint plan found" and "the sprint plan lists no stories" send the reader to different fixes, and Section 7 already draws that distinction for the handoff block.
Before checking any stories, load reference documents once (not per-story):
design/gdd/systems-index.md — to know which systems have approved GDDsdocs/architecture/control-manifest.md — story-readiness needs only the header
Manifest Version: date (its manifest check is existence + version, not the rule
bodies), so grep it (Grep pattern="Manifest Version" path="docs/architecture/control-manifest.md")
rather than a full read. If the file does not exist, note it as missing once; do not
re-flag per story.docs/architecture/tr-registry.yaml — index all entries by id. Used to
validate TR-IDs in stories. If the file does not exist, note it once; TR-ID
checks will auto-pass for all stories (registry predates stories, so missing
registry means stories are from before TR tracking was introduced).Status: value is a single line; reading whole ADR files to find it costs the
entire architecture corpus, and in all scope that multiplies across every
story in the repo:
Grep pattern="^## Status" glob="docs/architecture/adr-*.md" output_mode="content" -A 3
Establish the denominator first (glob docs/architecture/adr-*.md, count N)
and interpret against it: 0 matches with N > 0 means malformed ADRs, not
"no Accepted ADRs" — report "run /architecture-decision [file] retrofit"
rather than failing every story's ADR check. Never treat an unreadable status as
a failed one. Cache the resulting map; do not re-scan per story.sprint) — to identify Must Have /
Should Have priority for escalation decisionsFor each story file, evaluate every item below. A story is READY only if all items pass or are explicitly marked N/A with a stated reason.
Workflow tier adjustment (resolved in Phase 0, per the story's system). The full checklist below is the
fullbaseline:
full— every item is blocking (TR registry + ADR + control manifest fully validated).standard— Design Completeness and Scope Clarity stay blocking. In Architecture Completeness, only a critical (Foundation-layer) ADR that is missing orProposedBLOCKS; a missing non-critical ADR, or an absent "ADR referenced" note, is advisory (NEEDS WORK note, not BLOCKED). The TR-ID and manifest items are advisory.minimal— acceptance-criteria check only: evaluate Design Completeness and Scope Clarity. Treat the entire Architecture Completeness section as N/A — do not flag missing ADR / TR-ID / manifest references.
design/gdd/ path
and quotes or links a specific requirement, acceptance criterion, or rule from
that GDD — not just the GDD filename. A link to the document without tracing
to a specific requirement does not pass.Type: Visual/Feel): Criteria like
"feels responsive" or "looks good" are not testable without a defined
benchmark. For Logic, Integration, UI, and Config/Data stories, these must be
replaced with specific observable conditions. For Visual/Feel stories, subjective
criteria are expected and this check auto-passes — instead verify that each
subjective criterion has a paired playtest protocol or evidence requirement
(e.g., "evidence doc required at production/qa/evidence/[slug]-evidence.md").
PASS if the acceptance criterion ends with or is accompanied by an explicit reference to a file path such as production/qa/evidence/[slug]-evidence.md. NEEDS WORK if the criterion is purely subjective with no evidence file path specified.The
BLOCKED/ fail outcomes in this section are thefullbaseline. Apply the tier note above: atstandardonly a missing/Proposed critical ADR BLOCKS (other items advisory); atminimaltreat this entire section as N/A.
Status: field using the cached ADR statuses loaded in Section 2.
Status: Accepted → pass.Status: Proposed → BLOCKED: the ADR may change before it is accepted,
and the story's implementation guidance could be wrong.
Fix: BLOCKED: ADR-NNNN is Proposed — wait for acceptance before implementing.TR-[system]-NNN
reference, look it up in the TR registry loaded in Section 2.
status: active → pass.status: deprecated or status: superseded-by: ... →
NEEDS WORK: the requirement was removed or replaced.
Fix: update the story to reference the current requirement ID or remove if no longer applicable./architecture-review run).Manifest Version: date
in its header AND docs/architecture/control-manifest.md exists:
Manifest Version: → pass.Manifest Version: to current.Manifest Version: field OR the manifest
does not exist.assets/, or file extensions .png, .jpg, .svg,
.wav, .ogg, .mp3, .glb, .gltf, .tres, .tscn, .res).
Type: field. If the story has fewer than the minimum, mark as NEEDS WORK.Type: field in its header
identifying the test category (Logic / Integration / Visual/Feel / UI / Config/Data).
Without this, test evidence requirements cannot be enforced at story close.
Fix: Add Type: [Logic|Integration|Visual/Feel|UI|Config/Data] to the story header.qa.level: minimal — no
test evidence is required, so this item never blocks): If the Story Type is set,
the story includes a ## Test Evidence section stating where evidence will be stored
(test file path for Logic/Integration, or evidence doc path for Visual/Feel/UI).
Resolve this item's gate level from the testing.strict block resolved in
Phase 0 — not by reading project.yaml, which would ignore a developer's
locally-overridden value. Map the Story Type to a key (Logic→logic,
Integration→integration, Visual/Feel→visual, UI→ui,
Config/Data→config) and take
testing.strict.<key>; use it only if its value is true or false
(case-insensitive). If the key is absent, empty, or holds any other value, read
testing.strict as a plain boolean (legacy single-value form); if that too is
absent or invalid, default to strict for Logic, Integration, Visual/Feel and UI,
and advisory for Config/Data. Surface any unrecognized value to the user.
## Test Evidence section marks the
story NEEDS WORK.## Test Evidence with the expected evidence location for the story's type.Assign one of three verdicts per story:
READY — All checklist items pass, have explicit N/A justifications, or are
advisory-level gaps (a checklist item whose gate level resolved to advisory via
testing.strict). Advisory gaps are still listed under Gaps in the output.
The story can be assigned immediately.
NEEDS WORK — One or more checklist items fail, but all dependency stories exist and are not DRAFT. The story can be fixed before assignment.
BLOCKED — One or more dependency stories are missing or in DRAFT state, OR a critical design question (flagged UNRESOLVED in a criterion or rule) has no owner. The story cannot be assigned until the blocker is resolved. Note: a story that is BLOCKED may also have NEEDS WORK items — list both.
## Story Readiness: [story title]
File: [path]
Verdict: [READY / NEEDS WORK / BLOCKED]
### Passing Checks (N/[total])
[list passing items briefly]
### Gaps
- [Checklist item]: [exact description of what is missing or wrong]
Fix: [specific text needed to resolve this gap]
### Blockers (if BLOCKED)
- [What is blocking]: [story ID or design question that must resolve first]
## Story Readiness Summary — [scope] — [date]
Ready: [N] stories
Needs Work: [N] stories
Blocked: [N] stories
### Ready Stories
- [story title] ([path])
### Needs Work
- [story title]: [primary gap — one line]
- [story title]: [primary gap — one line]
### Blocked Stories
- [story title]: Blocked by [story ID / design question]
---
[Full detail for each non-ready story follows, using the single-story format]
If the scope is sprint and any Must Have stories are NEEDS WORK or BLOCKED,
add a prominent warning at the top of the output:
WARNING: [N] Must Have stories are not implementation-ready.
[List them with their primary gap or blocker.]
Resolve these before the sprint begins or replan with `/sprint-plan update`.
This skill is read-only. It never proposes edits or asks to write files.
After reporting findings, offer:
"Would you like help filling in the gaps for any of these stories? I can draft the missing sections for your approval."
If the user says yes for a specific story, draft only the missing sections
in conversation. Do not use Write or Edit tools — the user (or
/create-stories) handles writing.
Redirect rules:
/create-epics [layer] then /create-stories [epic-slug] to generate stories from the GDD and ADR."/quick-design [description] to create a Quick Design Spec, then reference
that spec in the story."After completing a single-story readiness check (not all or sprint scope):
production/sprints/ (most recent).If any are found, surface up to 3:
### Other Ready Stories in This Sprint
1. [Story name] — [1-line description] — Est: [X hrs]
2. [Story name] — [1-line description] — Est: [X hrs]
Run `/story-readiness [path]` to validate before starting.
If no sprint file exists, or no other ready stories are found, say which — Next ready stories: no sprint file found or Next ready stories: none ready in [sprint] — rather than omitting the section. The two mean different things (nothing to read versus nothing ready) and an omitted section reads as neither.
Apply the review mode resolved in Phase 0 before spawning QL-STORY-READY:
solo → skip. Note: "QL-STORY-READY skipped — Solo mode." Proceed to close.lean → skip. Note: "QL-STORY-READY skipped — Lean mode." Proceed to close.full → spawn as normal.Spawn qa-lead via Agent using gate QL-STORY-READY (.claude/docs/director-gates/ql-story-ready.md).
Pass the following context:
Handle the verdict per standard rules in director-gates.md:
AskUserQuestion:
options: Update story with suggested gaps / Accept and proceed anyway / Discuss further./dev-story [story-path] to begin implementation once the story is READY/story-readiness sprint to check all stories in the current sprint at once/create-stories [epic-slug] if a story file is missing entirelydocs/architecture/control-manifest.md does not
exist yet (do not penalize stories written before the manifest was created).