Requirements, execution plan, functional design, code summaries, build and test results and the audit log; the reverse-engineering notes and the feature registry are updated. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
177 lines
10 KiB
Markdown
177 lines
10 KiB
Markdown
# Execution Plan
|
|
|
|
## Detailed Analysis Summary
|
|
|
|
### Transformation Scope
|
|
- **Transformation Type**: Single component area in one package (`web/`), plus one shared component that fans out to several pages
|
|
- **Primary Changes**: a new look and new behaviour for the "Lieve woorden" section (card over a landscape photo, counter instead of dots, no autoplay, horizontal slide), a new heading style in `SectionHeading`, and an optional `imagePosition` field in the content model
|
|
- **Related Components**: `Testimonials`, `TestimonialSlide`, `TestimonialCarousel`, `carouselControl` recipe, `SectionHeading` and its eight callers (`AboutBlock`, `ContactSection`, `IntroGallery`, `Pricing`, `Testimonials`, `InstagramGrid`, `AboutIntro`, `ShootPage`), `theme.ts` (text styles), `content/types.ts`, `content/testimonials.ts`, two new helpers in `web/src/lib`, `LAYOUT.md`
|
|
|
|
### Change Impact Assessment
|
|
- **User-facing changes**: Yes. The testimonials look and behave differently; every `SectionHeading` on the site gets uppercase, letter-spaced titles
|
|
- **Structural changes**: No. Same components, same route, same lazy-loading pattern
|
|
- **Data model changes**: Yes, small: one optional field `imagePosition` on `Testimonial`
|
|
- **API changes**: No
|
|
- **NFR impact**: Yes, checks only: accessibility (contrast, axe), no hydration mismatch, Lighthouse targets must hold, titles must not break on phones
|
|
|
|
### Component Relationships
|
|
|
|
```mermaid
|
|
graph TD
|
|
Theme["theme.ts text styles"]
|
|
SH["SectionHeading"]
|
|
Callers["Seven other callers: home sections, about intro, shoot page"]
|
|
Test["Testimonials, slide and carousel"]
|
|
Content["Testimonial content and type"]
|
|
Helpers["lib helpers: slideCounter, normalizeImagePosition"]
|
|
Recipe["carouselControl recipe"]
|
|
Theme --> SH
|
|
SH --> Callers
|
|
SH --> Test
|
|
Content --> Test
|
|
Helpers --> Test
|
|
Recipe --> Test
|
|
classDef style1 fill:#63b3ed,stroke:#2b6cb0,stroke-width:1px,color:#000;
|
|
classDef comp fill:#9ae6b4,stroke:#2f855a,stroke-width:1px,color:#000;
|
|
classDef data fill:#fbd38d,stroke:#92400e,stroke-width:1px,color:#000;
|
|
class Theme,Recipe style1;
|
|
class SH,Callers,Test comp;
|
|
class Content,Helpers data;
|
|
```
|
|
|
|
Text alternative: the theme text styles feed SectionHeading, which is used by its callers and by Testimonials; Testimonials also uses the content, two new helpers and the carousel control recipe.
|
|
|
|
| Component | Change type | Reason | Priority |
|
|
|---|---|---|---|
|
|
| `theme.ts` (new heading text style) | Minor | FR-TR-05 | Critical |
|
|
| `SectionHeading` and its eight callers | Minor | New style on every page that uses it; callers themselves do not change | Critical |
|
|
| `Testimonials`, `TestimonialSlide`, `TestimonialCarousel` | Major | New layout, controls, animation, placeholder | Critical |
|
|
| `carouselControl` recipe | Minor | Dots removed, arrows without circle | Important |
|
|
| `content/types.ts`, `content/testimonials.ts` | Minor | `imagePosition` | Important |
|
|
| `lib/slideCounter`, `lib/normalizeImagePosition` (new) | Minor | FR-TR-12, property tests | Important |
|
|
| `LAYOUT.md`, RE lines | Minor | FR-TR-14 | Optional |
|
|
|
|
### Risk Assessment
|
|
- **Risk Level**: Medium. The carousel is the heaviest code on the page and sits behind a lazy-load placeholder whose height must match; the heading change reaches several pages and may wrap titles on phones
|
|
- **Rollback Complexity**: Easy. One branch, no deployment or data change
|
|
- **Testing Complexity**: Moderate. The existing tests (including prerender, hydration and axe tests) must be adjusted; swiping can not be tested in jsdom, so it needs a manual check in a real browser
|
|
|
|
## Workflow Visualization
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
Start(["User Request"])
|
|
|
|
subgraph INCEPTION["🔵 INCEPTION PHASE"]
|
|
WD["Workspace Detection<br/><b>COMPLETED</b>"]
|
|
RE["Reverse Engineering<br/><b>SKIP</b>"]
|
|
RA["Requirements Analysis<br/><b>COMPLETED</b>"]
|
|
US["User Stories<br/><b>SKIP</b>"]
|
|
WP["Workflow Planning<br/><b>IN PROGRESS</b>"]
|
|
AD["Application Design<br/><b>SKIP</b>"]
|
|
UG["Units Generation<br/><b>SKIP</b>"]
|
|
end
|
|
|
|
subgraph CONSTRUCTION["🟢 CONSTRUCTION PHASE"]
|
|
FD1["Functional Design, unit 1<br/><b>SKIP</b>"]
|
|
CG1["Code Generation, unit 1<br/>section heading<br/><b>EXECUTE</b>"]
|
|
FD2["Functional Design, unit 2<br/><b>EXECUTE</b>"]
|
|
CG2["Code Generation, unit 2<br/>testimonials<br/><b>EXECUTE</b>"]
|
|
NFR["NFR Requirements, NFR Design,<br/>Infrastructure Design<br/><b>SKIP</b>"]
|
|
BT["Build and Test<br/><b>EXECUTE</b>"]
|
|
end
|
|
|
|
Start --> WD
|
|
WD --> RA
|
|
RA --> WP
|
|
WP --> CG1
|
|
CG1 --> FD2
|
|
FD2 --> CG2
|
|
CG2 --> BT
|
|
BT --> End(["Complete"])
|
|
|
|
style WD fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style RA fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style WP fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style CG1 fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style CG2 fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style BT fill:#4CAF50,stroke:#1B5E20,stroke-width:3px,color:#fff
|
|
style FD2 fill:#FFA726,stroke:#E65100,stroke-width:3px,stroke-dasharray: 5 5,color:#000
|
|
style RE fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style US fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style AD fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style UG fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style FD1 fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style NFR fill:#BDBDBD,stroke:#424242,stroke-width:2px,stroke-dasharray: 5 5,color:#000
|
|
style INCEPTION fill:#BBDEFB,stroke:#1565C0,stroke-width:3px,color:#000
|
|
style CONSTRUCTION fill:#C8E6C9,stroke:#2E7D32,stroke-width:3px,color:#000
|
|
style Start fill:#CE93D8,stroke:#6A1B9A,stroke-width:3px,color:#000
|
|
style End fill:#CE93D8,stroke:#6A1B9A,stroke-width:3px,color:#000
|
|
|
|
linkStyle default stroke:#333,stroke-width:2px
|
|
```
|
|
|
|
Text alternative: after Workflow Planning, unit 1 (section heading) goes straight to Code Generation; unit 2 (testimonials) has Functional Design and then Code Generation; Build and Test closes the feature. Reverse Engineering, User Stories, Application Design, Units Generation, the NFR stages and Infrastructure Design are skipped; there is no Operations phase.
|
|
|
|
## Units
|
|
|
|
The two units are fixed here, so Units Generation is skipped. They do not depend on each other for logic, only for looks, so unit 1 goes first (small, and the testimonials heading then already has its final style).
|
|
|
|
| Unit | Content | Requirements |
|
|
|---|---|---|
|
|
| 1. section-heading | New text style in `theme.ts`, used by `SectionHeading`; check the eight callers and every page that shows a `SectionHeading` (titles that wrap on a phone, tests and snapshots that name the old style) | FR-TR-05, A1, A2 |
|
|
| 2. testimonials | `imagePosition` in the content model, helpers `slideCounter` and `normalizeImagePosition` with property tests, new `TestimonialSlide` and `Testimonials` layout, controls and counter in `TestimonialCarousel` and the recipe, slide animation, placeholder height, tests, `LAYOUT.md` and RE lines | FR-TR-01..04, 06..14, NFR-TR-01..06 |
|
|
|
|
## Phases to Execute
|
|
|
|
### 🔵 INCEPTION PHASE
|
|
- [x] Workspace Detection (COMPLETED)
|
|
- [x] Reverse Engineering (SKIPPED)
|
|
- **Rationale**: shared artifacts exist; team agreement is no full refresh per feature. Only the lines about the testimonials and the heading are updated (FR-TR-14)
|
|
- [x] Requirements Analysis (COMPLETED)
|
|
- [x] User Stories (SKIPPED)
|
|
- **Rationale**: one type of visitor and concrete requirements from a reviewed design
|
|
- [x] Workflow Planning (IN PROGRESS)
|
|
- [ ] Application Design - SKIP
|
|
- **Rationale**: no new components or services; the two helpers are fully specified in FR-TR-12 and the layout decisions belong in Functional Design of unit 2
|
|
- [ ] Units Generation - SKIP
|
|
- **Rationale**: the two units are fixed in this plan
|
|
|
|
### 🟢 CONSTRUCTION PHASE
|
|
- [ ] Functional Design, unit 1 - SKIP
|
|
- **Rationale**: a style change with no logic; PBT-01 is N/A
|
|
- [ ] Functional Design, unit 2 - EXECUTE
|
|
- **Rationale**: layout geometry and overlap, how Chakra's carousel carries the slide animation, the placeholder height, the helpers and the testable properties (PBT-01)
|
|
- [ ] NFR Requirements - SKIP
|
|
- **Rationale**: the NFRs are in requirements.md; the PBT framework (`fast-check`) is already selected (PBT-09)
|
|
- [ ] NFR Design - SKIP
|
|
- **Rationale**: no new NFR patterns
|
|
- [ ] Infrastructure Design - SKIP
|
|
- **Rationale**: no infrastructure change
|
|
- [ ] Code Generation, unit 1 - EXECUTE (ALWAYS)
|
|
- [ ] Code Generation, unit 2 - EXECUTE (ALWAYS)
|
|
- [ ] Build and Test - EXECUTE (ALWAYS)
|
|
- **Rationale**: `pnpm check` (lint, types, tests, build, Lighthouse), a manual swipe check on a phone or in device mode, and a check of every page that shows a `SectionHeading`
|
|
|
|
### 🟡 OPERATIONS PHASE
|
|
- [ ] Deployment Setup, Monitoring Setup, Production Readiness Validation - SKIP
|
|
- **Rationale**: Operations Configuration = No (decided at Requirements Analysis)
|
|
|
|
## Package Change Sequence
|
|
|
|
Single package (`web/`). Order: unit 1 (heading), then unit 2 (testimonials), each with its own build and tests; Build and Test covers both together.
|
|
|
|
## Estimated Timeline
|
|
- **Total Phases**: 5 stages still to run (Functional Design for unit 2, two Code Generation stages, Build and Test, plus this plan)
|
|
- **Estimated Duration**: about the size of the shoot-type pages feature; the carousel and the placeholder are the long part
|
|
|
|
## Success Criteria
|
|
- **Primary Goal**: the testimonials match the approved canvas on desktop and phone, with no autoplay and no dots
|
|
- **Key Deliverables**: new `Testimonials` section, `SectionHeading` style, `imagePosition` field, two helpers with property tests, updated tests and `LAYOUT.md`
|
|
- **Quality Gates**:
|
|
- `pnpm check` green, Lighthouse targets not lowered
|
|
- No axe violations; contrast at least 4.5:1
|
|
- Hydrated page equals prerendered HTML
|
|
- Security Baseline and PBT compliance summaries at each applicable stage
|
|
- Manual swipe check and a look at every page with a `SectionHeading`
|