From 55b9fe3bdaace3ec94e59c0429473eb711165d20 Mon Sep 17 00:00:00 2001 From: Asish Kumar Date: Thu, 14 May 2026 09:21:15 +0530 Subject: [PATCH 1/2] docs: document high-assurance workflow --- docs/quickstart.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 0e6c0ab9d4..5f846ffc62 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -5,11 +5,19 @@ This guide will help you get started with Spec-Driven Development using Spec Kit > [!NOTE] > All automation scripts now provide both Bash (`.sh`) and PowerShell (`.ps1`) variants. The `specify` CLI auto-selects based on OS unless you pass `--script sh|ps`. -## The 6-Step Process +## Recommended Workflow > [!TIP] > **Context Awareness**: Spec Kit commands automatically detect the active feature based on your current Git branch (e.g., `001-feature-name`). To switch between different specifications, simply switch Git branches. +After installing Spec Kit and defining your project constitution, quick experiments can use the lean feature path: `/speckit.specify` -> `/speckit.plan` -> `/speckit.tasks` -> `/speckit.implement`. For production features or any work with meaningful ambiguity, treat `/speckit.clarify`, `/speckit.checklist`, and `/speckit.analyze` as regular quality gates: + +```text +/speckit.constitution -> /speckit.specify -> /speckit.clarify -> /speckit.checklist -> /speckit.plan -> /speckit.tasks -> /speckit.analyze -> /speckit.implement +``` + +Use `/speckit.clarify` to reduce requirement ambiguity before planning, `/speckit.checklist` to validate requirements quality before planning, and `/speckit.analyze` to check spec/plan/task consistency before implementation starts. + ### Step 1: Install Specify **In your terminal**, run the `specify` CLI command to initialize your project: @@ -24,10 +32,13 @@ uvx --from git+https://github.com/github/spec-kit.git specify init . > [!NOTE] > You can also install the CLI persistently with `pipx`: +> > ```bash > pipx install git+https://github.com/github/spec-kit.git > ``` +> > After installing with `pipx`, run `specify` directly instead of `uvx --from ... specify`, for example: +> > ```bash > specify init > specify init . @@ -56,7 +67,7 @@ uvx --from git+https://github.com/github/spec-kit.git specify init Date: Thu, 14 May 2026 22:13:03 +0530 Subject: [PATCH 2/2] docs: clarify analyze workflow gate Signed-off-by: Asish Kumar --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 5f846ffc62..d278465d8d 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -16,7 +16,7 @@ After installing Spec Kit and defining your project constitution, quick experime /speckit.constitution -> /speckit.specify -> /speckit.clarify -> /speckit.checklist -> /speckit.plan -> /speckit.tasks -> /speckit.analyze -> /speckit.implement ``` -Use `/speckit.clarify` to reduce requirement ambiguity before planning, `/speckit.checklist` to validate requirements quality before planning, and `/speckit.analyze` to check spec/plan/task consistency before implementation starts. +Use `/speckit.clarify` to reduce requirement ambiguity before planning, `/speckit.checklist` to validate requirements quality before planning, and `/speckit.analyze` to check spec/plan/task consistency before implementation starts. You can repeat `/speckit.analyze` after implementation as an extra review, but keep the first analysis before `/speckit.implement` so gaps are caught while the plan and tasks can still be adjusted. ### Step 1: Install Specify