Skip to content

Commit cc4d90f

Browse files
committed
feat(product): v1.5.2 hardening - compliance checklist, validation scripts, strict template enforcement
- Added CRITICAL COMPLIANCE CHECKLIST to implement.md with strict enforcement rules - Added validation scripts: validate-prd.sh, validate-pdr.sh - Restructured prd-template.md: Visual Summary = Section 1 (numbered), Document Info = Section 2 - Added compliance banners to section templates (overview.md, requirements.md) - Added ASCII to Mermaid conversion instructions in implement.md - Created TROUBLESHOOTING.md guide with common issues and fixes - Updated README.md with validation scripts section - Bumped extension version: 1.5.1 -> 1.5.2 - Bumped CLI version: 0.8.12+adlc9 -> 0.8.12+adlc10
1 parent 68832ce commit cc4d90f

11 files changed

Lines changed: 1529 additions & 105 deletions

File tree

extensions/product/CHANGELOG.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,58 @@
22

33
All notable changes to the Product extension will be documented in this file.
44

5+
## [1.5.2] - 2026-05-19
6+
7+
### Added
8+
9+
- **CRITICAL COMPLIANCE CHECKLIST**: Added strict compliance requirements to `commands/implement.md`
10+
- MUST use templates (not generate from scratch)
11+
- MUST use Mermaid diagrams (ASCII art prohibited in main content)
12+
- MUST place Visual Summary as Section 1 (numbered)
13+
- MUST validate output with validation scripts
14+
15+
- **Validation Scripts**: New bash scripts in `scripts/bash/`
16+
- `validate-prd.sh`: Validates PRD compliance with v1.5.2 standards
17+
- Checks Visual Summary is Section 1
18+
- Detects ASCII diagrams in main content
19+
- Validates Mermaid syntax
20+
- Checks unfilled placeholders
21+
- Verifies PDR traceability
22+
- Supports `--strict` and `--warn` modes
23+
- `validate-pdr.sh`: Validates PDR completeness
24+
- Checks constitution is populated (not template)
25+
- Validates required sections
26+
- Reports inconsistency flags
27+
28+
- **Template Compliance Banners**: Added to all section templates
29+
- HTML comment banners at top of each template
30+
- Reminds to use Mermaid (not ASCII)
31+
- Notes section numbering in final PRD
32+
- References validation script
33+
34+
### Changed
35+
36+
- **PRD Template Restructure** (`templates/prd-template.md`):
37+
- Section 1: Visual Summary (now **numbered**)
38+
- Section 2: Document Information (**new section**)
39+
- Sections 3-13: Renumbered content sections
40+
- Added compliance banner at top
41+
- Added validation checklist at bottom
42+
43+
- **Hardened implement.md Command**:
44+
- Added CRITICAL COMPLIANCE CHECKLIST at top
45+
- Added STRICT ENFORCEMENT RULES section
46+
- Enhanced template loading instructions (MUST read template first)
47+
- Added ASCII to Mermaid conversion instructions
48+
- Added validation step to section generation workflow
49+
50+
### Fixed
51+
52+
- **ASCII Diagram Detection**: Added explicit detection and conversion instructions
53+
- ASCII diagrams only allowed in `<details>` blocks as fallbacks
54+
- Main content MUST use Mermaid
55+
- Added validation check for box-drawing characters
56+
557
## [1.5.1] - 2026-05-19
658

759
### Fixed

extensions/product/README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,34 @@ Validate feature spec alignment with PRD (READ-ONLY).
128128
- Metric alignment
129129
- Traceability verification
130130

131+
### Validation Scripts (v1.5.2+)
132+
133+
Validate PRD/PDR compliance before or after generation:
134+
135+
```bash
136+
# Validate PRD compliance (strict mode)
137+
.specify/extensions/product/scripts/bash/validate-prd.sh PRD.md --strict
138+
139+
# Validate with warnings only
140+
.specify/extensions/product/scripts/bash/validate-prd.sh PRD.md --warn
141+
142+
# Validate PDR completeness
143+
.specify/extensions/product/scripts/bash/validate-pdr.sh .specify/drafts/pdr.md
144+
```
145+
146+
**Validation Checks:**
147+
148+
- Visual Summary is Section 1 (numbered)
149+
- No ASCII diagrams in main content (Mermaid required)
150+
- All placeholders filled
151+
- PDR traceability for requirements
152+
- Constitution alignment (if claimed)
153+
154+
**Exit Codes:**
155+
- `0`: All checks passed ✓
156+
- `1`: Errors found (strict mode)
157+
- `2`: Warnings only (warn mode)
158+
131159
## Workflow
132160

133161
### Greenfield Product
@@ -233,9 +261,30 @@ Located in `templates/sections/`:
233261
## Templates
234262

235263
- [pdr-template.md](./templates/pdr-template.md) - Product Decision Record format
236-
- [prd-template.md](./templates/prd-template.md) - Product Requirements Document format
264+
- [prd-template.md](./templates/prd-template.md) - Product Requirements Document format (v1.5.2: Visual Summary is Section 1)
237265
- `templates/sections/` - Individual section templates for DAG workflow
238266

267+
### Template Compliance (v1.5.2+)
268+
269+
All templates include compliance banners reminding you to:
270+
- ✓ Use Mermaid diagrams (NOT ASCII art)
271+
- ✓ Fill ALL [PLACEHOLDERS]
272+
- ✓ Trace content to PDRs
273+
- ✓ Validate with `./scripts/validate-prd.sh --strict`
274+
275+
**Note:** v1.5.2 restructured `prd-template.md`:
276+
- Section 1: Visual Summary (numbered)
277+
- Section 2: Document Information
278+
- Sections 3-13: Content sections
279+
280+
## Troubleshooting
281+
282+
See [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for:
283+
- Common issues and fixes
284+
- ASCII to Mermaid conversion
285+
- Validation error resolution
286+
- Regeneration procedures
287+
239288
## Examples
240289

241290
See [CNE Agent PRD example](../../CNE%20Agent%20(2).md) for a complete PRD example.

0 commit comments

Comments
 (0)