Skip to content

Commit 1d00a17

Browse files
committed
doc: update doc files with the right project name and refercing the 12 factors
1 parent 45a7a2b commit 1d00a17

File tree

7 files changed

+56
-33
lines changed

7 files changed

+56
-33
lines changed

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,6 @@ Use **`/speckit.implement`** to execute all tasks and build your feature accordi
124124

125125
For detailed step-by-step instructions, see our [comprehensive guide](./spec-driven.md).
126126

127-
## 📽️ Video Overview
128-
129-
Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)!
130-
131-
[![Spec Kit video header](/media/spec-kit-video-header.jpg)](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
132-
133127
## 🤖 Supported AI Agents
134128

135129
| Agent | Support | Notes |

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation
22

3-
This folder contains the documentation source files for Agentic SDLC Spec Kit, built using [DocFX](https://dotnet.github.io/docfx/).
3+
This folder contains the documentation source files for Agentic SDLC Spec Kit, built using [DocFX](https://dotnet.github.io/docfx/). Agentic SDLC Spec Kit is built upon the [Agentic SDLC 12 Factors](https://tikalk.github.io/agentic-sdlc-12-factors/) methodology for structured AI-assisted development.
44

55
## Building Locally
66

docs/index.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Spec Kit
1+
# Agentic SDLC Spec Kit
22

33
*Build high-quality software faster.*
44

@@ -53,6 +53,25 @@ Our research and experimentation focus on:
5353
- Provide robust iterative feature development workflows
5454
- Extend processes to handle upgrades and modernization tasks
5555

56+
## Alignment with Agentic SDLC 12 Factors
57+
58+
Spec-Driven Development is built upon the [Agentic SDLC 12 Factors](https://tikalk.github.io/agentic-sdlc-12-factors/) methodology, a comprehensive framework for software development with AI coding agents. The 12 factors provide the foundational principles that guide our approach:
59+
60+
- [I. Strategic Mindset](https://tikalk.github.io/agentic-sdlc-12-factors/content/strategic-mindset.html): Developer as Orchestrator, AI as Intern
61+
- [II. Context Scaffolding](https://tikalk.github.io/agentic-sdlc-12-factors/content/context-scaffolding.html): Treat Context as a Dependency
62+
- [III. Mission Definition](https://tikalk.github.io/agentic-sdlc-12-factors/content/mission-definition.html): From Intent to Specification
63+
- [IV. Structured Planning](https://tikalk.github.io/agentic-sdlc-12-factors/content/structured-planning.html): Decompose and Triage Tasks
64+
- [V. Dual Execution Loops](https://tikalk.github.io/agentic-sdlc-12-factors/content/dual-execution-loops.html): Pair Program or Delegate Toil
65+
- [VI. The Great Filter](https://tikalk.github.io/agentic-sdlc-12-factors/content/great-filter.html): Apply Irreplaceable Human Judgment
66+
- [VII. Adaptive Quality Gates](https://tikalk.github.io/agentic-sdlc-12-factors/content/adaptive-quality-gates.html): Review Appropriately for Each Workflow
67+
- [VIII. AI-Augmented, Risk-Based Testing](https://tikalk.github.io/agentic-sdlc-12-factors/content/ai-augmented-testing.html): AI-Augmented, Risk-Based Testing
68+
- [IX. Traceability](https://tikalk.github.io/agentic-sdlc-12-factors/content/traceability.html): Linking the 'Why' to the 'How'
69+
- [X. Strategic Tooling](https://tikalk.github.io/agentic-sdlc-12-factors/content/strategic-tooling.html): Manage a Federated, Governed Stack
70+
- [XI. Directives as Code](https://tikalk.github.io/agentic-sdlc-12-factors/content/directives-as-code.html): Version and Share AI Behavior
71+
- [XII. Team Capability](https://tikalk.github.io/agentic-sdlc-12-factors/content/team-capability.html): Systematize Learning and Improvement
72+
73+
This alignment ensures that Agentic SDLC Spec Kit provides a structured, high-velocity approach to AI-assisted development while maintaining quality and accountability.
74+
5675
## Contributing
5776

5877
Please see our [Contributing Guide](https://github.com/github/spec-kit/blob/main/CONTRIBUTING.md) for information on how to contribute to this project.

docs/installation.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Installation Guide
22

3+
> Agentic SDLC Spec Kit implements the [Agentic SDLC 12 Factors](https://tikalk.github.io/agentic-sdlc-12-factors/) methodology for structured AI-assisted development.
4+
35
## Prerequisites
46

57
- **Linux/macOS** (or Windows; PowerShell scripts now supported without WSL)
@@ -15,25 +17,25 @@
1517
The easiest way to get started is to initialize a new project:
1618

1719
```bash
18-
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>
20+
uvx --from git+https://github.com/github/agentic-sdlc-agentic-sdlc-spec-kit.git specify init <PROJECT_NAME>
1921
```
2022

2123
Or initialize in the current directory:
2224

2325
```bash
24-
uvx --from git+https://github.com/github/spec-kit.git specify init .
26+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init .
2527
# or use the --here flag
26-
uvx --from git+https://github.com/github/spec-kit.git specify init --here
28+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init --here
2729
```
2830

2931
### Specify AI Agent
3032

3133
You can proactively specify your AI agent during initialization:
3234

3335
```bash
34-
uvx --from git+https://github.com/github/spec-kit.git specify init <project_name> --ai claude
35-
uvx --from git+https://github.com/github/spec-kit.git specify init <project_name> --ai gemini
36-
uvx --from git+https://github.com/github/spec-kit.git specify init <project_name> --ai copilot
36+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <project_name> --ai claude
37+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <project_name> --ai gemini
38+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <project_name> --ai copilot
3739
```
3840

3941
### Specify Script Type (Shell vs PowerShell)
@@ -47,16 +49,16 @@ Auto behavior:
4749

4850
Force a specific script type:
4951
```bash
50-
uvx --from git+https://github.com/github/spec-kit.git specify init <project_name> --script sh
51-
uvx --from git+https://github.com/github/spec-kit.git specify init <project_name> --script ps
52+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <project_name> --script sh
53+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <project_name> --script ps
5254
```
5355

5456
### Ignore Agent Tools Check
5557

5658
If you prefer to get the templates without checking for the right tools:
5759

5860
```bash
59-
uvx --from git+https://github.com/github/spec-kit.git specify init <project_name> --ai claude --ignore-agent-tools
61+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <project_name> --ai claude --ignore-agent-tools
6062
```
6163

6264
## Verification

docs/local-development.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Local Development Guide
22

3-
This guide shows how to iterate on the `specify` CLI locally without publishing a release or committing to `main` first.
3+
This guide shows how to iterate on the `specify` CLI locally without publishing a release or committing to `main` first. This process aligns with [X. Strategic Tooling](https://tikalk.github.io/agentic-sdlc-12-factors/content/strategic-tooling.html), managing a governed stack of development tools for controlled and efficient workflows.
44

55
> Scripts now have both Bash (`.sh`) and PowerShell (`.ps1`) variants. The CLI auto-selects based on OS unless you pass `--script sh|ps`.
66
77
## 1. Clone and Switch Branches
88

99
```bash
10-
git clone https://github.com/github/spec-kit.git
10+
git clone https://github.com/github/agentic-sdlc-spec-kit.git
1111
cd spec-kit
1212
# Work on a feature branch
1313
git checkout -b your-feature-branch
@@ -60,27 +60,27 @@ You can also point uvx at a specific branch without merging:
6060
```bash
6161
# Push your working branch first
6262
git push origin your-feature-branch
63-
uvx --from git+https://github.com/github/spec-kit.git@your-feature-branch specify init demo-branch-test --script ps
63+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git@your-feature-branch specify init demo-branch-test --script ps
6464
```
6565

6666
### 4a. Absolute Path uvx (Run From Anywhere)
6767

6868
If you're in another directory, use an absolute path instead of `.`:
6969

7070
```bash
71-
uvx --from /mnt/c/GitHub/spec-kit specify --help
72-
uvx --from /mnt/c/GitHub/spec-kit specify init demo-anywhere --ai copilot --ignore-agent-tools --script sh
71+
uvx --from /mnt/c/GitHub/agentic-sdlc-spec-kit specify --help
72+
uvx --from /mnt/c/GitHub/agentic-sdlc-spec-kit specify init demo-anywhere --ai copilot --ignore-agent-tools --script sh
7373
```
7474

7575
Set an environment variable for convenience:
7676
```bash
77-
export SPEC_KIT_SRC=/mnt/c/GitHub/spec-kit
77+
export SPEC_KIT_SRC=/mnt/c/GitHub/agentic-sdlc-spec-kit
7878
uvx --from "$SPEC_KIT_SRC" specify init demo-env --ai copilot --ignore-agent-tools --script ps
7979
```
8080

8181
(Optional) Define a shell function:
8282
```bash
83-
specify-dev() { uvx --from /mnt/c/GitHub/spec-kit specify "$@"; }
83+
specify-dev() { uvx --from /mnt/c/GitHub/agentic-sdlc-spec-kit specify "$@"; }
8484
# Then
8585
specify-dev --help
8686
```
@@ -139,7 +139,7 @@ specify init demo --skip-tls --ai gemini --ignore-agent-tools --script ps
139139
| Run CLI directly | `python -m src.specify_cli --help` |
140140
| Editable install | `uv pip install -e .` then `specify ...` |
141141
| Local uvx run (repo root) | `uvx --from . specify ...` |
142-
| Local uvx run (abs path) | `uvx --from /mnt/c/GitHub/spec-kit specify ...` |
142+
| Local uvx run (abs path) | `uvx --from /mnt/c/GitHub/agentic-sdlc-spec-kit specify ...` |
143143
| Git branch uvx | `uvx --from git+URL@branch specify ...` |
144144
| Build wheel | `uv build` |
145145

docs/quickstart.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ This guide will help you get started with Spec-Driven Development using Agentic
77
## Stage 0: Foundation & Setup
88

99
**Goal:** Establish the foundational rules and configure the development environment so every later stage aligns with the project's architectural and security principles.
10-
**Note:** Run these steps in a standard terminal before opening the Intelligent IDE.
10+
**Note:** Run these steps in a standard terminal before opening the Intelligent IDE.
11+
**Alignment with 12 Factors:** This stage establishes the foundation guided by [I. Strategic Mindset](https://tikalk.github.io/agentic-sdlc-12-factors/content/strategic-mindset.html) and [II. Context Scaffolding](https://tikalk.github.io/agentic-sdlc-12-factors/content/context-scaffolding.html), positioning the developer as orchestrator and assembling necessary context for AI collaboration.
1112

1213
1. **Project Initialization (`/init`)**
1314
**Action:** From the project root, run the Agentic SDLC Spec Kit `init` command (e.g., `specify init <project> --team-ai-directives https://github.com/your-org/team-ai-directives.git`) to configure local settings and clone the shared `team-ai-directives` modules.
@@ -27,7 +28,8 @@ This guide will help you get started with Spec-Driven Development using Agentic
2728
## Stage 1: Feature Specification
2829

2930
**Goal:** Produce a committed `spec.md` that captures the feature's intent, constraints, and acceptance criteria.
30-
**Note:** From Stage 1 onward, all work happens inside the Intelligent IDE with the context automatically assembled by Agentic SDLC Spec Kit.
31+
**Note:** From Stage 1 onward, all work happens inside the Intelligent IDE with the context automatically assembled by Agentic SDLC Spec Kit.
32+
**Alignment with 12 Factors:** This stage focuses on [III. Mission Definition](https://tikalk.github.io/agentic-sdlc-12-factors/content/mission-definition.html), translating intent into formal, version-controlled specifications.
3133

3234
1. **Craft the Directive (`/specify`)**
3335
**Action:** Author a single, comprehensive natural-language directive that blends the issue tracker mission, personas, constraints, and any clarifications.
@@ -50,7 +52,8 @@ This guide will help you get started with Spec-Driven Development using Agentic
5052
## Stage 2: Planning & Task Management
5153

5254
**Goal:** Convert the committed `spec.md` into a human-approved `plan.md` and a synced task list that routes work through the issue tracker.
53-
**Note:** `/plan` and `/tasks` run inside the IDE, reusing the constitution and the locally cloned `team-ai-directives` modules.
55+
**Note:** `/plan` and `/tasks` run inside the IDE, reusing the constitution and the locally cloned `team-ai-directives` modules.
56+
**Alignment with 12 Factors:** This stage implements [IV. Structured Planning](https://tikalk.github.io/agentic-sdlc-12-factors/content/structured-planning.html) and [V. Dual Execution Loops](https://tikalk.github.io/agentic-sdlc-12-factors/content/dual-execution-loops.html), decomposing tasks and triaging them for synchronous or asynchronous execution.
5457

5558
1. **Generate the Plan (`/plan`)**
5659
**Action:** Execute `/plan` with a directive that covers tech stack, risk considerations, testing focus, and any implementation preferences. Agentic SDLC Spec Kit loads `memory/constitution.md`, references in `team-ai-directives`, and copies the plan template before executing automation.
@@ -67,7 +70,8 @@ This guide will help you get started with Spec-Driven Development using Agentic
6770
## Stage 3: Implementation
6871

6972
**Goal:** Execute the validated plan, honoring the `[SYNC]/[ASYNC]` execution modes and completing every task in `tasks.md`.
70-
**Note:** Use `/implement` within the IDE; the command enforces the TDD order, dependency rules, and execution modes captured in Stages 1-2.
73+
**Note:** Use `/implement` within the IDE; the command enforces the TDD order, dependency rules, and execution modes captured in Stages 1-2.
74+
**Alignment with 12 Factors:** This stage applies [VI. The Great Filter](https://tikalk.github.io/agentic-sdlc-12-factors/content/great-filter.html), [VII. Adaptive Quality Gates](https://tikalk.github.io/agentic-sdlc-12-factors/content/adaptive-quality-gates.html), and [VIII. AI-Augmented, Risk-Based Testing](https://tikalk.github.io/agentic-sdlc-12-factors/content/ai-augmented-testing.html), ensuring human judgment filters AI output with appropriate review processes and targeted testing.
7175

7276
1. **Execute Tasks (`/implement`)**
7377
**Action:** Run `/implement` to load `plan.md`, `tasks.md`, and supporting artifacts. Follow the phase-by-phase flow, completing tests before implementation and respecting `[SYNC]/[ASYNC]` modes and `[P]` parallel markers.
@@ -81,7 +85,8 @@ This guide will help you get started with Spec-Driven Development using Agentic
8185
## Stage 4: Leveling Up
8286

8387
**Goal:** Capture best practices from the completed feature, draft a reusable knowledge asset in `team-ai-directives`, and generate traceability notes for the original issue.
84-
**Note:** `/levelup` runs inside the IDE and relies on the locally cloned directives repository from Stage 0.
88+
**Note:** `/levelup` runs inside the IDE and relies on the locally cloned directives repository from Stage 0.
89+
**Alignment with 12 Factors:** This stage encompasses [IX. Traceability](https://tikalk.github.io/agentic-sdlc-12-factors/content/traceability.html), [X. Strategic Tooling](https://tikalk.github.io/agentic-sdlc-12-factors/content/strategic-tooling.html), [XI. Directives as Code](https://tikalk.github.io/agentic-sdlc-12-factors/content/directives-as-code.html), and [XII. Team Capability](https://tikalk.github.io/agentic-sdlc-12-factors/content/team-capability.html), linking artifacts, managing tools, versioning AI behavior, and systematizing learning.
8590

8691
1. **Run Level-Up Workflow (`/levelup`)**
8792
**Action:** Invoke `/levelup` with a strategic directive (e.g., highlight what should become reusable). Agentic SDLC Spec Kit gathers spec/plan/tasks metadata, validates the directives repo, and prompts you to synthesize a knowledge asset plus PR/issue summaries.
@@ -105,13 +110,13 @@ This guide will help you get started with Spec-Driven Development using Agentic
105110
Initialize your project depending on the coding agent you're using:
106111

107112
```bash
108-
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>
113+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <PROJECT_NAME>
109114
```
110115

111116
Pick script type explicitly (optional):
112117
```bash
113-
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> --script ps # Force PowerShell
114-
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> --script sh # Force POSIX shell
118+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <PROJECT_NAME> --script ps # Force PowerShell
119+
uvx --from git+https://github.com/github/agentic-sdlc-spec-kit.git specify init <PROJECT_NAME> --script sh # Force POSIX shell
115120
```
116121

117122
### 2. Create the Spec

roadmap.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@
117117
-**Guild-log.md Handling**: Feedback loop integration
118118
-**Automated Evaluation Reports**: Guild performance insights
119119

120+
#### **Documentation & Outreach**
121+
-**Video Overview Creation**: Produce introductory video demonstrating Agentic SDLC Spec Kit workflow
122+
120123
---
121124

122125
## 📈 **IMPLEMENTATION STATUS SUMMARY**

0 commit comments

Comments
 (0)