Skip to content

docs: align spec 001 acceptance scenarios with blueprint-grade AC standard#118

Merged
singyichen merged 2 commits into
mainfrom
docs/spec-001-ac-alignment
Jul 21, 2026
Merged

docs: align spec 001 acceptance scenarios with blueprint-grade AC standard#118
singyichen merged 2 commits into
mainfrom
docs/spec-001-ac-alignment

Conversation

@singyichen

Copy link
Copy Markdown
Owner

Purpose

Bring spec 001 (login — email/password) acceptance scenarios up to the blueprint-grade AC writing principles and the new stable-ID format, serving as the reference example for future spec alignments.

Reason

An audit of specs/account against the acceptance-criteria skill's writing principles (aligned with spec-template v1.5.0 / checklist CHK032-033) found four recurring gaps: inspection-style When clauses, vague timing values, missing edge-case density, and no stable scenario IDs. Spec 001 exhibits three of the four, making it the natural demonstration target. Existing specs remain grandfathered and will be aligned on their next version bump.

Result

Gap Before After
Inspection-style When "When viewing the login card" (tester action) "When page load completes" (observable trigger); assertion target moved into Then
Vague timing "~800ms" in scenario, FR-011, SC-003 Named constant REDIRECT_DELAY_MS = 800 in the spec-constants section
Edge-case density 4 Q&A items 8 items, adding simultaneous-rule priority (loading vs language toggle; both fields empty), time boundary (double-click before redirect), and degraded data (localStorage unavailable / invalid lang value)
Scenario IDs Positional list numbers only AC-1.1AC-5.3 per spec-template v1.5.0

Also removes a duplicated requirement-source line and bumps the spec to v1.2.3.

Changed Files

File Change
specs/account/001-login-email-password/spec.md Scenario rewrites, REDIRECT_DELAY_MS constant, expanded edge cases, AC-N.N IDs, duplicate-line cleanup, changelog v1.2.3

Test Plan

  • Docs-only change — no code or prototype behavior affected
  • All 17 scenarios carry sequential AC-<story>.<seq> IDs with no gaps or duplicates
  • REDIRECT_DELAY_MS replaces "~800ms" in all normative sections (scenario AC-3.2, FR-011, SC-003); historical clarification records intentionally untouched
  • Spec version, changelog entry, and frontmatter are consistent (v1.2.3)

Impact Scope

  • Frontend
  • Admin
  • API
  • Queue
  • Other: spec documentation

Related

Follow-up to #117 (AC ID governance)

🤖 Generated with Claude Code

…ndard

- **Rewrite** inspection-style When clauses (four scenarios) as system-observable triggers (page load complete / language-toggle click) so each scenario maps 1:1 to a Playwright act-assert pair
- **Replace** the vague "~800ms" redirect timing with a named `REDIRECT_DELAY_MS = 800` spec constant across the scenario, FR-011, and SC-003
- **Expand** edge cases from 4 to 8, covering the three priority categories from the blueprint standard: simultaneous rule triggers, time boundaries, and degraded-data fallback
- **Add** stable `AC-N.N` IDs to all 17 acceptance scenarios per spec-template v1.5.0
- **Remove** a duplicated requirement-source line and bump the spec to v1.2.3 with a changelog entry

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.

Review Summary

This PR successfully aligns spec 001 with blueprint-grade acceptance criteria standards. The changes are well-executed and improve specification quality:

Key Improvements:

  • ✅ Replaced inspection-style When clauses with observable events (e.g., "When 檢視登入卡片" → "When 頁面載入完成")
  • ✅ Introduced REDIRECT_DELAY_MS constant replacing vague "約 800ms" references
  • ✅ Added stable AC IDs (AC-1.1 through AC-5.3) following spec-template v1.5.0
  • ✅ Expanded edge cases from 4 to 8 items, adding important scenarios for simultaneous errors, timing boundaries, and data degradation
  • ✅ Removed duplicate requirement source line
  • ✅ Consistent version bump to 1.2.3 with complete changelog entry

All changes are documentation-focused with no functional defects. The specification is now more testable, maintainable, and aligned with the stated acceptance criteria principles.


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 refines the login specification by introducing a REDIRECT_DELAY_MS constant, assigning stable IDs to acceptance criteria, and adding several boundary cases. The reviewer suggests making the language toggle acceptance criteria bidirectional to ensure complete test coverage for both Chinese-to-English and English-to-Chinese transitions.

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 specs/account/001-login-email-password/spec.md
- **Add** AC-4.5 covering the en-to-zh transition with a concrete Given value, so the language toggle is verified bidirectionally (Gemini finding on line 146); the generic "switch to the other language" phrasing was rejected because it would violate the concrete-values-in-Given principle this PR adopts
- **Replace** the last remaining vague "about 800ms" mention in the scope notes with the REDIRECT_DELAY_MS constant introduced by this PR, completing the constant migration

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@singyichen
singyichen merged commit 773d311 into main Jul 21, 2026
9 checks passed
@singyichen
singyichen deleted the docs/spec-001-ac-alignment branch July 21, 2026 08:21
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