8.0 KiB
Story 10.6: Documentation Update
Story
As a developer I want to update all documentation to reflect the new brand colors So that future development references accurate color information
Acceptance Criteria
AC1: CLAUDE.md Updated
Given CLAUDE.md contains color guidance
When I update the file
Then the following sections are updated:
- Design Requirements section
- Color scheme references (Navy → Charcoal, Gold → Warm Gray)
- Any hex value references
AC2: PRD Updated
Given docs/prd.md contains detailed color specifications
When I update the document
Then the following sections are updated:
- Section 7.1 Brand Identity & Visual Guidelines
- Color Palette table
- All hex value references
- Button styling specifications
- Any Navy/Gold color mentions
AC3: Architecture Document Updated
Given docs/architecture.md may contain color references
When I review and update the document
Then any color references are updated to new palette
AC4: Epic 9 Stories Referenced as Superseded
Given Epic 9 stories implemented the original Navy+Gold palette When I review Epic 9 story files Then a note is added indicating colors were updated in Epic 10:
story-9.1-color-system-implementation.mdstory-9.4-component-styling-buttons.mdstory-9.5-component-styling-forms.md- Other affected stories
AC5: Epic 10 Document Updated
Given docs/epics/epic-10-brand-color-refresh.md exists
When all stories are complete
Then the epic document is updated with completion status
AC6: brand.md Verified Accurate
Given docs/brand.md defines the new brand
When I review the document
Then it accurately describes:
- The botanical/wheat logo
- Correct color palette (Charcoal, Warm Gray, Off-White, Deep Black)
- Typography guidelines
- Usage guidelines
AC7: No Stale Color References
Given documentation should be accurate When I search all markdown files for old hex values Then no references to old colors remain:
#0A1F44(old Navy) - replaced or removed#D4AF37(old Gold) - replaced or removed#F4E4B8(old Gold Light) - replaced or removed#F9F7F4(old Cream) - replaced or removed#2C3E50(old Charcoal) - replaced or removed
Technical Notes
Files to Update
Core Documentation:
CLAUDE.mddocs/prd.mddocs/architecture.mddocs/brand.md(verify accuracy)
Epic Files:
docs/epics/epic-10-brand-color-refresh.mddocs/epics/epic-9-design-branding.md(add supersession note)
Story Files (44 files contain old hex values):
docs/stories/story-9.1-color-system-implementation.mddocs/stories/story-9.4-component-styling-buttons.mddocs/stories/story-9.5-component-styling-forms.mddocs/stories/story-9.6-component-styling-cards-containers.mddocs/stories/story-9.7-navigation-footer-styling.mddocs/stories/story-9.10-accessibility-compliance.md- And others found via grep
Color Replacement Reference
| Old Color | Old Hex | New Color | New Hex |
|---|---|---|---|
| Navy Blue | #0A1F44 |
Charcoal | #4A4A42 |
| Gold | #D4AF37 |
Warm Gray | #C9C4BA |
| Gold Light | #F4E4B8 |
Off-White | #E8E4DC |
| Cream | #F9F7F4 |
Off-White | #E8E4DC |
| Charcoal | #2C3E50 |
Deep Black | #1A1A1A |
Search Commands
To find all old color references:
# Find files with old hex values
grep -r "#0A1F44\|#D4AF37\|#F4E4B8\|#F9F7F4\|#2C3E50" docs/
# Find Navy/Gold word references
grep -ri "navy\|gold" docs/*.md
Documentation Update Pattern
For Epic 9 stories, add a note at the top:
> **Note:** The color values in this story were implemented with the original Navy+Gold palette.
> These colors were updated in Epic 10 (Brand Color Refresh) to the new Charcoal+Warm Gray palette.
> See `docs/brand.md` for current color specifications.
Dev Checklist
- Update
CLAUDE.mdcolor references - Update
docs/prd.mdSection 7.1 Color Palette - Update
docs/prd.mdall other color references - Review and update
docs/architecture.md - Verify
docs/brand.mdis accurate - Add supersession note to
story-9.1-color-system-implementation.md - Add supersession note to
story-9.4-component-styling-buttons.md - Add supersession note to
story-9.5-component-styling-forms.md - Add supersession note to other affected Epic 9 stories
- Update
epic-10-brand-color-refresh.mdwith completion status - Run grep to verify no old hex values remain
- Review all documentation for consistency
Estimation
Complexity: Low Risk: Low - Documentation only, no code impact
Dependencies
- Should be completed last, after Stories 10.1-10.5 are done
- Ensures documentation reflects actual implemented state
Dev Agent Record
Status: Ready for Review
Agent Model Used: Claude Opus 4.5
Completion Notes
- Updated CLAUDE.md Design Requirements section with new Charcoal+Warm Gray palette
- Updated docs/prd.md comprehensively: Section 7.1 color palette, logo usage, visual elements, button styling, dashboard color schemes, email requirements, design success criteria
- Updated docs/architecture.md: CSS @theme block and Color Palette table
- Verified docs/brand.md is accurate and complete with botanical logo, all 4 colors, typography, and usage guidelines
- Added supersession notes to all Epic 9 stories (9.1, 9.3, 9.4, 9.5, 9.6, 9.7, 9.10) and epic-9-design-branding.md
- Added supersession notes to Epic 8 stories (8.1, 8.2, 8.3) and epic-8-email-notifications.md
- Added supersession notes to Epic 1, 6, 7 stories and epics that referenced old colors
- Updated epic-10-brand-color-refresh.md with all stories marked Complete and Definition of Done items checked
- Updated docs/qa/gates/2.5-account-creation-email-notification.yml with new color references
- Core documentation (CLAUDE.md, prd.md, architecture.md, brand.md) now have no old hex values
- All historical story/epic files with old hex values now have supersession notes pointing to docs/brand.md
File List
Modified:
- CLAUDE.md
- docs/prd.md
- docs/architecture.md
- docs/epics/epic-10-brand-color-refresh.md
- docs/epics/epic-9-design-branding.md
- docs/epics/epic-8-email-notifications.md
- docs/epics/epic-1-core-foundation.md
- docs/stories/story-9.1-color-system-implementation.md
- docs/stories/story-9.3-logo-integration.md
- docs/stories/story-9.4-component-styling-buttons.md
- docs/stories/story-9.5-component-styling-forms.md
- docs/stories/story-9.6-component-styling-cards-containers.md
- docs/stories/story-9.7-navigation-footer-styling.md
- docs/stories/story-9.10-accessibility-compliance.md
- docs/stories/story-8.1-email-infrastructure-setup.md
- docs/stories/story-8.2-welcome-email.md
- docs/stories/story-8.3-booking-submitted-confirmation.md
- docs/stories/story-7.1-client-dashboard-overview.md
- docs/stories/story-6.1-dashboard-overview-statistics.md
- docs/stories/story-6.2-analytics-charts.md
- docs/stories/story-6.4-data-export-user-lists.md
- docs/stories/story-6.5-data-export-consultation-records.md
- docs/stories/story-6.6-data-export-timeline-reports.md
- docs/stories/story-6.7-monthly-statistics-report.md
- docs/stories/story-2.5-account-creation-email-notification.md
- docs/stories/story-1.4-base-ui-navigation.md
- docs/qa/gates/2.5-account-creation-email-notification.yml
- docs/stories/story-10.6-documentation-update.md
Change Log
| Date | Change | Files |
|---|---|---|
| 2026-01-03 | Updated color scheme references to Charcoal+Warm Gray palette | CLAUDE.md |
| 2026-01-03 | Updated Section 7.1 color palette, logo usage, visual elements, buttons | docs/prd.md |
| 2026-01-03 | Updated CSS @theme colors and Color Palette table | docs/architecture.md |
| 2026-01-03 | Added supersession notes to all affected story/epic files | 22 story/epic files |
| 2026-01-03 | Marked all stories Complete in Epic 10 | docs/epics/epic-10-brand-color-refresh.md |
| 2026-01-03 | Updated color reference in QA gate recommendation | docs/qa/gates/2.5-account-creation-email-notification.yml |