Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: Add missing prompt commands + existing project walkthrough#937

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
anchildress1 wants to merge14 commits intogithub:main
base:main
Choose a base branch
Loading
fromanchildress1:update-user-guide-docs
Open
Changes from1 commit
Commits
Show all changes
14 commits
Select commitHold shift + click to select a range
0e32149
docs: Add guide for using Spec-Kit in existing projects
anchildress1Oct 16, 2025
c69f5d1
docs: Enhance quickstart guide with clarifications and examples
anchildress1Oct 17, 2025
75f86ab
docs(spec-driven): add detailed /speckit command reference
anchildress1Oct 18, 2025
83a307a
Merge branch 'github:main' into update-user-guide-docs
anchildress1Oct 18, 2025
87b71cd
docs(existing-project-guide): normalize hyphen usage
anchildress1Oct 18, 2025
787340d
docs(existing-project-guide): normalize hyphenation and punctuation
anchildress1Oct 18, 2025
2132e7c
Merge branch 'github:main' into update-user-guide-docs
anchildress1Oct 19, 2025
0b19492
docs: normalize "Spec Kit" naming and fix minor formatting
anchildress1Oct 19, 2025
5a322bc
docs: add Copilot instructions shim and docs/AGENTS.md
anchildress1Oct 19, 2025
8202820
docs: clarify existing-project-guide and spec-driven timing
anchildress1Oct 19, 2025
c46b0d6
Merge branch 'main' into update-user-guide-docs
localdenOct 21, 2025
b458ccf
Merge origin/update-user-guide-docs changes; include existing-project…
anchildress1Nov 16, 2025
16add6c
Merge branch 'main' into update-user-guide-docs
anchildress1Dec 11, 2025
6b4557c
chore: Moving proposed copilot-instructions to separate PR
anchildress1Dec 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
PrevPrevious commit
NextNext commit
docs: Enhance quickstart guide with clarifications and examples
- Add step-by-step explanations for each phase of the workflow- Include constitution step in detailed example for complete process- Add cross-references to related documentation guides- Improve navigation between new project and existing project workflowsGenerated-by: GitHub Copilot <github.copilot@github.com>Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com>
  • Loading branch information
@anchildress1
anchildress1 committedOct 17, 2025
commitc69f5d1ffefbe0776f17ac9b70025c23aa037330
42 changes: 34 additions & 8 deletionsdocs/quickstart.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
# Quick Start Guide

This guide will help you get started with Spec-Driven Development using Spec Kit.
This guide will help you get started with Spec-Driven Development using Spec Kit for **new projects**.

> **Already have a project?** See the [Existing Project Guide](existing-project-guide.md) for a streamlined workflow.
>
> NEW: 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 4-Step Process

### 1. Install Specify

Create a new project directory and set up Spec-Kit with your preferred AI coding agent.

> For detailed installation options, see the [Installation Guide](installation.md).

Initialize your project depending on the coding agent you're using:

```bash
Expand All@@ -22,6 +28,8 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME

### 2. Create the Spec

Define your feature requirements in plain language—describe what users need and why, without worrying about implementation details or technical requirements. This should clearly state the goal in user-centric terms.

Use the `/speckit.specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.

```bash
Expand All@@ -30,6 +38,8 @@ Use the `/speckit.specify` command to describe what you want to build. Focus on

### 3. Create a Technical Implementation Plan

Translate your spec into concrete technical decisions—frameworks, databases, and architecture patterns.

Use the `/speckit.plan` command to provide your tech stack and architecture choices.

```bash
Expand All@@ -38,12 +48,27 @@ Use the `/speckit.plan` command to provide your tech stack and architecture choi

### 4. Break Down and Implement

Use `/speckit.tasks` to create an actionable task list, then ask your agent to implement the feature.
Generate a step-by-step task list from your plan, then execute those tasks to build your feature.

Use `/speckit.tasks` to create an actionable task list, then prompt your agent with `/speckit.implement` to execute the tasks.

---

## Detailed Example: Building Taskify

Here's a complete example of building a team productivity platform:

### Step 0: Establish Project Principles (Recommended)

Before creating features, use `/speckit.constitution` to define your project's governing principles:

```text
/speckit.constitution Establish core principles for this project:
- Test-first development is mandatory - tests written and approved before implementation
- API response times must stay under 200ms
- Real integration tests over mocks - use actual database instances for testing
```

### Step 1: Define Requirements with `/speckit.specify`

```text
Expand DownExpand Up@@ -101,10 +126,11 @@ Read through it with an eye on determining whether or not there is a sequence of
to be doing that are obvious from reading this. Because I don't know if there's enough here.
```

Finally, implement the solution:
Finally,generate tasks andimplement the solution:

```text
implement specs/002-create-taskify/plan.md
/speckit.tasks
/speckit.implement 002-create-taskify
```

## Key Principles
Expand All@@ -117,7 +143,7 @@ implement specs/002-create-taskify/plan.md

## Next Steps

-Read the complete methodology for in-depth guidance
-Check out more examples in the repository
-Explore the source code on GitHub

-**Adding features to existing projects?** Use the [Existing Project Guide](existing-project-guide.md)
-**Deep dive:** Read the [complete methodology](../spec-driven.md) for in-depth guidance
-**Local development:** See [Local Development Guide](local-development.md) for CLI development workflows
- **Troubleshooting:** Check the main [README troubleshooting section](../README.md#-troubleshooting)

[8]ページ先頭

©2009-2025 Movatter.jp