Skip to content

Commit fb13bd3

Browse files
committed
docs: amend constitution to v1.1.0 (add documentation guidelines)
- Add prohibition of auto-generated summary/report documents - Clarify acceptable documentation types - Establish rationale for living documentation approach - Update version from 1.0.0 to 1.1.0 (MINOR) - Last amended date: 2025-10-07
1 parent 9711879 commit fb13bd3

1 file changed

Lines changed: 37 additions & 7 deletions

File tree

‎.specify/memory/constitution.md‎

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<!--
22
Sync Impact Report:
3-
Version change: Initial → 1.0.0
4-
Added sections:
5-
- Core Principles: Component-First, TypeScript-First, User Experience, Internationalization, Performance
6-
- Quality Standards: Code quality and testing requirements
7-
- Development Workflow: Contribution and review process
8-
Templates requiring updates: ✅ All templates validated
3+
Version change: 1.0.0 → 1.1.0
4+
Modified sections:
5+
- Development Workflow: Added "Documentation Guidelines" subsection
6+
Added principles/rules:
7+
- Prohibition of auto-generated summary/report documents
8+
Templates requiring updates:
9+
- ✅ .specify/templates/plan-template.md (reviewed, no changes needed)
10+
- ✅ .specify/templates/spec-template.md (reviewed, no changes needed)
11+
- ✅ .specify/templates/tasks-template.md (not changed, guideline applies to all outputs)
912
Follow-up TODOs: None
1013
-->
1114

@@ -79,6 +82,33 @@ Bundle size must be optimized through code splitting and lazy loading. API calls
7982
- Performance impact must be assessed for large changes
8083
- Accessibility compliance must be verified
8184

85+
### Documentation Guidelines
86+
87+
**Prohibition of Generated Summary Documents**
88+
89+
AI agents and automated tools MUST NOT create summary, report, or analysis documents such as:
90+
91+
- Coverage reports (e.g., `COVERAGE_REPORT.md`)
92+
- Implementation summaries
93+
- Progress reports
94+
- Analysis documents
95+
- Any form of procedurally generated documentation files
96+
97+
**Rationale**: Generated documentation becomes stale immediately, creates maintenance burden, and clutters the repository. Test coverage and implementation progress are better tracked through:
98+
99+
- CI/CD pipeline outputs
100+
- Version control history
101+
- Living documentation in README files
102+
- Inline code comments and JSDoc
103+
- Test files themselves
104+
105+
**Exceptions**: The only acceptable documentation files are:
106+
107+
- Hand-written README files explaining project setup and architecture
108+
- API documentation generated by tools like TypeDoc (but only when explicitly configured)
109+
- Changelog files maintained through conventional commits
110+
- Project constitution and specification documents (`.specify/` directory)
111+
82112
## Governance
83113

84114
### Amendment Process
@@ -105,4 +135,4 @@ Constitution changes require:
105135
- Use CLAUDE.md for runtime development guidance specific to Claude
106136
- Regular reviews ensure principles remain relevant
107137

108-
**Version**: 1.0.0 | **Ratified**: 2025-01-27 | **Last Amended**: 2025-01-27
138+
**Version**: 1.1.0 | **Ratified**: 2025-01-27 | **Last Amended**: 2025-10-07

0 commit comments

Comments
 (0)