You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit fb13bd3
Browse filesBrowse the repository at this point in the historyBrowse files
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
Copy file name to clipboardExpand all lines: .specify/memory/constitution.md
+37-7Lines changed: 37 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,14 @@
1
1
<!--
2
2
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)
9
12
Follow-up TODOs: None
10
13
-->
11
14
@@ -79,6 +82,33 @@ Bundle size must be optimized through code splitting and lazy loading. API calls
79
82
- Performance impact must be assessed for large changes
80
83
- Accessibility compliance must be verified
81
84
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
+
82
112
## Governance
83
113
84
114
### Amendment Process
@@ -105,4 +135,4 @@ Constitution changes require:
105
135
- Use CLAUDE.md for runtime development guidance specific to Claude
0 commit comments