Skip to content

Commit cc71ded

Browse files
committed
Enhance documentation and command templates for improved clarity and usability
- Updated `.documentation/why-i-forked-spec-kit.md` to clarify key design decisions and solutions. - Refined branch protection rules in `.github/BRANCH_PROTECTION.md` for better guidance. - Improved output formatting in `.github/workflows/scripts/README.md` for consistency. - Adjusted markdown linting rules in `.markdownlint-cli2.jsonc` to disable MD060. - Enhanced descriptions and features in `AGENTS.md` for clarity on command functionalities. - Updated `README.md` to improve feature descriptions and usage instructions. - Refined `git-spark-report.md` for better presentation of repository health metrics. - Enhanced `spec-driven.md` with clearer command usage and feature descriptions. - Improved command templates for `critic.md`, `discover-constitution.md`, `evolve-constitution.md`, `pr-review.md`, `quickfix.md`, and `release.md` for better user guidance and consistency.
1 parent da97f85 commit cc71ded

23 files changed

Lines changed: 429 additions & 84 deletions

.documentation/adaptive-lifecycle.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Adaptive System Life Cycle Development
22

3-
*An AI-Agent Driven Approach to Software Development Life Cycle Management*
3+
> An AI-Agent Driven Approach to Software Development Life Cycle Management
44
55
---
66

@@ -72,7 +72,7 @@ Systems and documentation must evolve together:
7272

7373
The constitution serves as the foundational document defining system architecture, coding standards, and development guidelines.
7474

75-
```
75+
```text
7676
Constitution Lifecycle:
7777
┌─────────────────────────────────────────────────────────────────┐
7878
│ │
@@ -89,6 +89,7 @@ Constitution Lifecycle:
8989
```
9090

9191
**Key Commands:**
92+
9293
- `/speckit.constitution` - Create or update constitution
9394
- `/speckit.discover-constitution` - Generate from existing codebase (brownfield)
9495
- `/speckit.evolve-constitution` - Propose amendments based on findings
@@ -97,7 +98,7 @@ Constitution Lifecycle:
9798

9899
The toolkit provides workflows scaled to task complexity:
99100

100-
```
101+
```text
101102
Task Complexity Routing:
102103
┌─────────────────────────────────────────────────────────────────┐
103104
│ │
@@ -130,6 +131,7 @@ Task Complexity Routing:
130131
```
131132

132133
**Full Spec Workflow:**
134+
133135
```bash
134136
/speckit.specify # Define requirements
135137
/speckit.plan # Technical planning
@@ -139,6 +141,7 @@ Task Complexity Routing:
139141
```
140142

141143
**Lightweight Workflow:**
144+
142145
```bash
143146
/speckit.quickfix # Create, validate, implement, complete
144147
```
@@ -147,7 +150,7 @@ Task Complexity Routing:
147150

148151
PRs serve dual purposes: code review and constitution evolution triggers.
149152

150-
```
153+
```text
151154
PR Review Flow:
152155
┌─────────────────────────────────────────────────────────────────┐
153156
│ │
@@ -183,7 +186,7 @@ PR Review Flow:
183186

184187
Documentation lifecycle management ensures artifacts remain current:
185188

186-
```
189+
```text
187190
Documentation Lifecycle:
188191
┌─────────────────────────────────────────────────────────────────┐
189192
│ │
@@ -214,6 +217,7 @@ Documentation Lifecycle:
214217
```
215218

216219
**Key Principle**: Development artifacts (specs, plans, tasks) are working documents. At release boundaries, they are:
220+
217221
1. Archived with the release version
218222
2. Key decisions extracted as ADRs
219223
3. Summarized in release notes
@@ -277,7 +281,7 @@ Documentation Lifecycle:
277281

278282
### Workflow Selection Guide
279283

280-
```
284+
```text
281285
Should I use full spec workflow or quickfix?
282286
─────────────────────────────────────────────
283287
@@ -333,7 +337,7 @@ Site audits produce compliance scores:
333337

334338
Each site audit is saved with a timestamp, enabling trend analysis:
335339

336-
```
340+
```text
337341
Technical Debt Trend:
338342
┌─────────────────────────────────────────────────────────────────┐
339343
│ Compliance % │

.documentation/constitution-guide.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Use the `/speckit.constitution` command to create or update your constitution:
4040
```
4141

4242
The discover command will:
43+
4344
1. Scan your codebase for patterns (testing, security, architecture, code quality)
4445
2. Report what it finds with confidence levels (high/medium/low consistency)
4546
3. Ask 8-10 targeted questions to validate findings and fill gaps
@@ -49,16 +50,19 @@ The discover command will:
4950
### Example Prompts
5051

5152
**Security-focused project**:
53+
5254
```bash
5355
/speckit.constitution Security-first principles: no hardcoded secrets, mandatory input validation, parameterized SQL queries, rate limiting required on all public endpoints
5456
```
5557

5658
**TDD-focused project**:
59+
5760
```bash
5861
/speckit.constitution Strict TDD with test-first development, minimum 80% coverage, integration tests for all API endpoints, red-green-refactor cycle enforced
5962
```
6063

6164
**Enterprise project**:
65+
6266
```bash
6367
/speckit.constitution Enterprise standards: code review required, documentation for all public APIs, changelog updates mandatory, semantic versioning, accessibility compliance
6468
```
@@ -215,6 +219,7 @@ A constitution with 50 principles is hard to follow. Focus on 5-10 core principl
215219
### 6. Review and Update
216220

217221
Periodically review your constitution:
222+
218223
- Are principles being followed?
219224
- Are any principles causing friction without value?
220225
- Have new concerns emerged that need principles?
@@ -251,24 +256,28 @@ These principles are still valid! The automated commands will flag *potential* i
251256
### Tips for Auditable Principles
252257

253258
1. **Include specific patterns to check for**:
259+
254260
```markdown
255261
- No `console.log` statements in production code (MUST)
256262
- No `// TODO` comments older than 30 days (SHOULD)
257263
```
258264

259265
2. **Specify file/directory conventions**:
266+
260267
```markdown
261268
- All API routes MUST be in `/src/routes/`
262269
- Test files MUST be named `*.test.ts` or `*.spec.ts`
263270
```
264271

265272
3. **Define measurable thresholds**:
273+
266274
```markdown
267275
- Files MUST NOT exceed 500 lines
268276
- Functions MUST NOT have more than 5 parameters
269277
```
270278

271279
4. **List prohibited patterns explicitly**:
280+
272281
```markdown
273282
- MUST NOT use `eval()`, `Function()`, or `setTimeout(string)`
274283
- MUST NOT disable ESLint rules inline without justification comment
@@ -281,6 +290,7 @@ The constitution should contain **principles**—fundamental rules that define y
281290
### The Litmus Test
282291

283292
**Put it in the Constitution if:**
293+
284294
- Violating it would be a showstopper in PR review
285295
- It applies project-wide, not to specific components
286296
- It's a *principle*, not an implementation detail
@@ -335,7 +345,7 @@ When using AI coding assistants like GitHub Copilot, Claude Code, or OpenAI Code
335345

336346
### The Hierarchy: Constitution as Source of Truth
337347

338-
```
348+
```text
339349
┌─────────────────────────────────────────┐
340350
│ /.documentation/memory/constitution.md │ ← Principles (WHAT must be true)
341351
│ Non-negotiable, agent-agnostic rules │
@@ -378,6 +388,7 @@ Key principles include:
378388
```
379389

380390
**Why reference instead of copy?**
391+
381392
- Single source of truth prevents drift
382393
- Constitution updates automatically apply
383394
- No risk of conflicting instructions
@@ -401,6 +412,7 @@ Key principles include:
401412
### Example: Complementary Files
402413

403414
**`/.documentation/memory/constitution.md`** (principles):
415+
404416
```markdown
405417
### II. Security First
406418

@@ -411,6 +423,7 @@ Key principles include:
411423
```
412424

413425
**`.github/copilot-instructions.md`** (implementation guidance):
426+
414427
```markdown
415428
## Security Implementation
416429

@@ -439,7 +452,8 @@ If your team uses multiple agents (Copilot, Claude, Cursor), create consistent i
439452
3. **Consider a shared include**: Some teams create `.documentation/ai-context.md` that all agent files reference
440453

441454
**Example structure**:
442-
```
455+
456+
```text
443457
/.documentation/
444458
memory/
445459
constitution.md # Principles (all agents)
@@ -462,6 +476,7 @@ If agent instructions conflict with the constitution:
462476
3. **Consider intent**: If the agent instruction seems better, propose a constitution amendment instead
463477

464478
**Signs of conflict**:
479+
465480
- Agent suggests a library but constitution requires a different approach
466481
- Agent's code patterns violate constitution principles
467482
- Different files give different answers to the same question

0 commit comments

Comments
 (0)