-
Notifications
You must be signed in to change notification settings - Fork 9.6k
docs: add hands-off orchestration example #2801
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
meow2149
wants to merge
6
commits into
github:main
Choose a base branch
from
meow2149:docs/2789-hands-off-orchestration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+85
−1
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b08ae10
docs: add hands-off orchestration example
meow2149 0ccb821
docs: clarify orchestration example guidance
meow2149 5154d17
docs: align orchestration example workflow
meow2149 0dbf86b
Potential fix for pull request finding
meow2149 ce7c683
Potential fix for pull request finding
meow2149 048d760
Potential fix for pull request finding
meow2149 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Hands-Off Orchestration Example | ||
|
|
||
| This example shows how to ask an AI coding agent to run a hands-off, artifact-first Spec Kit flow without moving into issue creation or implementation by default. | ||
|
|
||
| Use this pattern when you want a repeatable planning pass that produces reviewed artifacts first: | ||
|
|
||
| ```text | ||
| /speckit.specify -> /speckit.clarify -> /speckit.checklist -> /speckit.plan -> /speckit.tasks -> /speckit.analyze | ||
| ``` | ||
|
|
||
| This ordering matches the [Quick Start Guide](../quickstart.md) recommended workflow, where `/speckit.checklist` is a requirements-quality gate before `/speckit.plan`. | ||
|
|
||
| The key rule is that the agent stops after analysis unless the user explicitly asks it to continue. | ||
|
|
||
| > [!NOTE] | ||
| > This conservative example uses only `README.md` and `DESIGN.md` as in-repo guidance sources unless the user explicitly provides more context. | ||
|
|
||
| ## Guardrails | ||
|
|
||
| - Generate and review artifacts before creating issues or writing code. | ||
| - Ask the user when a product decision is required. | ||
| - Loop back to an earlier stage when a later stage finds stale, incomplete, or inconsistent artifacts. | ||
| - Use only `README.md` and `DESIGN.md` as in-repo guidance sources unless the user explicitly provides more context. | ||
| - Do not run `/speckit.taskstoissues` unless the user explicitly requests issue creation. | ||
| - Do not run `/speckit.implement` unless the user explicitly requests implementation. | ||
|
mnriem marked this conversation as resolved.
|
||
|
|
||
| ## Example Agent Prompt | ||
|
|
||
| Copy this prompt into your agent after initializing a Spec Kit project: | ||
|
|
||
| ```text | ||
| Run an artifact-first Spec Kit orchestration flow for the following feature: | ||
|
|
||
| <describe the feature here> | ||
|
|
||
| Follow this sequence: | ||
|
|
||
| 1. Run /speckit.specify for the requested feature. | ||
| 2. Run /speckit.clarify to identify ambiguity. If a real product decision is required, stop and ask me before continuing. | ||
| 3. Run /speckit.checklist and fix requirement-quality gaps by looping back to /speckit.clarify or /speckit.specify as needed. | ||
| 4. Run /speckit.plan after the specification passes the requirements checklist. | ||
| 5. Run /speckit.tasks after the plan and checklist are consistent. | ||
| 6. Run /speckit.analyze to check cross-artifact consistency. | ||
|
mnriem marked this conversation as resolved.
|
||
| 7. Stop after analysis and report the generated artifacts, open questions, and recommended next step. | ||
|
|
||
| Use only README.md and DESIGN.md as in-repo guidance sources unless I explicitly provide more context. | ||
| Do not create GitHub issues unless I explicitly ask for issue creation. | ||
| Do not implement tasks unless I explicitly ask for implementation. | ||
| ``` | ||
|
|
||
| ## Optional Follow-Up Prompts | ||
|
|
||
| After reviewing the generated artifacts, continue with one of these explicit prompts: | ||
|
|
||
| ```text | ||
| Run /speckit.taskstoissues to create GitHub issues from the generated tasks, but do not implement them. | ||
| ``` | ||
|
|
||
| ```text | ||
| Run /speckit.implement to implement the generated tasks now. | ||
| ``` | ||
|
|
||
| Keeping issue creation and implementation as separate follow-up prompts makes the default flow safe for planning, design review, and handoff scenarios. | ||
|
|
||
| ## When To Use This Pattern | ||
|
|
||
| Use this pattern when: | ||
|
|
||
| - A team lead wants implementation-ready artifacts before assigning work. | ||
| - A project wants consistent specs, plans, and tasks for every feature request. | ||
| - The feature has enough ambiguity that clarification and checklist passes are useful. | ||
| - You want automation to prepare work, but not silently create issues or write code. | ||
|
|
||
| For smaller experiments, the shorter workflow in the [Quick Start Guide](../quickstart.md) may be enough. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.