Skip to content

docs: define story-number stability and source-tag examples for AC IDs#119

Closed
singyichen wants to merge 2 commits into
mainfrom
docs/spec-ac-ids-followup
Closed

docs: define story-number stability and source-tag examples for AC IDs#119
singyichen wants to merge 2 commits into
mainfrom
docs/spec-ac-ids-followup

Conversation

@singyichen

Copy link
Copy Markdown
Owner

Purpose

Close the two remaining Codex findings on the AC stable-ID standard introduced in #117: story-number stability and demonstrated source tags.

Reason

Two Codex findings were posted on #117 after it merged:

  1. [High] The acceptance-criteria skill's Output Format examples did not demonstrate the (Source: AC-N.N) traceability tag the skill itself mandates, so generated checklists would likely omit it.
  2. [Medium] AC-<story>.<seq> IDs embed the story number, but nothing forbade renumbering stories on insertion or priority reordering — which would silently break every published AC ID.

Result

Finding Resolution
Missing Source tags in examples AC-F01–F03 in the acceptance-criteria skill's Core Behavior examples now end with (Source: AC-1.1) / (Source: AC-1.2) / (Source: AC-1.3)
Story renumbering breaks AC IDs spec-template v1.5.1 + spec-format skill now state: story numbers are identities, not positions — new stories take the next unused number, existing stories are never renumbered; display order may follow priority, but AC IDs follow the story number

Changed Files

File Change
.specify/templates/spec-template.md Story-number stability added to the AC ID guidance comment; changelog v1.5.1
.claude/skills/spec-format/SKILL.md Same stability rule appended to the AC ID rules paragraph
.claude/skills/acceptance-criteria/SKILL.md Core Behavior example criteria now demonstrate (Source: AC-N.N) tags

Test Plan

  • Docs-only change — no code paths affected
  • Template changelog row added (v1.5.1) and version header consistent
  • Wording identical between spec-template comment and spec-format skill rule

Impact Scope

  • Frontend
  • Admin
  • API
  • Queue
  • Other: SDD governance templates and skills

Related

#117

🤖 Generated with Claude Code

- **Define** story numbers as identities, not positions: new stories take the next unused number and are never renumbered, so AC-<story>.<seq> IDs survive story insertion or priority-based reordering (Codex P2 finding on #117); spec-template bumped to v1.5.1
- **Sync** the spec-format skill's AC ID rule with the same story-number stability wording
- **Show** the (Source: AC-N.N) tag on the acceptance-criteria skill's Core Behavior examples so generated standalone checklists demonstrate the traceability principle instead of only stating it (Codex P1 finding on #117)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@singyichen singyichen added the docs 文件需求/修正 — Documentation additions or fixes label Jul 21, 2026
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation improvements are correctly implemented. The changes successfully address the two Codex findings by adding traceability source tags to examples and establishing story-number stability rules. The wording is consistent across spec-template and spec-format skill, and the changelog properly documents version 1.5.1.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the specification templates and skill guidelines to clarify that User Story numbers are stable identifiers rather than positional indicators, ensuring that story numbers and their associated Acceptance Criteria (AC) IDs remain unchanged when display order is adjusted. Additionally, source mappings were added to the functional acceptance criteria in the skill documentation, and the template changelog was updated to version 1.5.1. The feedback recommends a minor phrasing improvement in the template instructions to clarify 'AC ID 的故事段' as 'AC ID 中的故事編號部分' for better precision.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread .specify/templates/spec-template.md Outdated
- **Replace** the ambiguous shorthand "AC ID story segment" with "the story-number part of the AC ID" in the stability guidance comment, per Gemini's clarity finding; the spec-format skill wording was already unambiguous and needed no change

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@singyichen singyichen closed this Jul 21, 2026
@singyichen
singyichen deleted the docs/spec-ac-ids-followup branch July 21, 2026 08:39
singyichen added a commit that referenced this pull request Jul 21, 2026
- **Resolve** the spec-template changelog conflict by keeping both entries: 1.6.0 (this branch) above 1.5.1 (PR #119 story-number stability rule, merged to main after this branch was cut)
- **Verify** PR #119's story-number stability additions auto-merged intact into the v1.6.0 AC comment block and the spec-format skill

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs 文件需求/修正 — Documentation additions or fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant