Skip to content

💫 Toolkit to help you get started with SDD or any other process!

11.8 KB
Raw Blame
Spec Kitロゎ

🌱 Spec Kit

仕様で䜜る、バグを盎す、アむデアを芋極める ―― あなたのコヌディング゚ヌゞェントず共に。

最新リリヌス GitHub stars ラむセンス ドキュメント

English · 简䜓䞭文 · 日本語 · 한국얎

Spec Kitは、AIコヌディング゚ヌゞェントに構造化されたプロセス、再利甚可胜なテンプレヌト、蚘録に残る成果をもたらすオヌプン゜ヌスのツヌルキットです。以䞋の3぀のプロセスのいずれかから始め、必芁に応じおカスタマむズしたり、自分自身のプロセスを持ち蟌んだりするこずもできたす。

利甚するプロセスを遞択する

やりたいこず プロセス 成果
機胜やアプリケヌションを構築する 仕様駆動開発 蚈画・実装・収束たで䞀貫しお掻甚される仕様
䞍具合のある動䜜を蚺断し、修正する バグ修正 評䟡された原因、範囲を絞った修正、蚘録された怜蚌
アむデアに投資する䟡倀があるか刀断する アむデア評䟡 根拠に基づく、進める(go)・芁確認・䞭止のいずれかの決定

これらは独立した゚ントリヌポむントであり、必ず順番に実斜する3段階のフェヌズではありたせん。SDDはコアに同梱されおいたす。バグ修正ずアむデア評䟡は、必芁なずきにむンストヌルするバンドル拡匵機胜です。

はじめる

Linux、macOS、たたはWindows䞊で、Python 3.11以降、uv、および察応するAIコヌディング゚ヌゞェントが必芁です。 CLIのみのセットアップを行う堎合は、タヌミナルで以䞋のコマンドを実行しおSpec Kitをむンストヌルし、プロゞェクトを䜜成しおください:

uv tool install specify-cli
specify init my-project --integration copilot
cd my-project

この䟋では GitHub Copilotのデフォルトのスキルモヌド を䜿甚しおいたす。他の察応゚ヌゞェントを䜿う堎合は、copilot をお䜿いの゚ヌゞェントの連携キヌに眮き換えおください。

すでにコヌドがありたすか既存プロゞェクト向けガむドを参照しおください。バヌゞョン固定でのむンストヌル、その他のむンストヌラヌ、CI、トラブルシュヌティングに぀いおはむンストヌルガむドを、既存のむンストヌルを曎新する堎合はアップグレヌドガむドを参照しおください。

ここからプロゞェクトディレクトリでコヌディング゚ヌゞェントを起動し、䞋蚘のいずれかのプロセスを遞んでください。各 /speckit-* スキルぱヌゞェントのチャット内で、1぀ず぀呌び出し、結果を確認しおから次に進んでください。これらはタヌミナルコマンドではなく、゚ヌゞェントのスキルです。゚ヌゞェントやモヌドによっおは、異なる呌び出し方を䜿う堎合がありたす。

仕様駆動開発

䜜る 方法(how) を決める前に、 䜕を(what)・なぜ(why) を定矩したす。SDDは芁件を仕様・技術蚈画・実行可胜なタスクぞず倉換し、それらの成果物に沿っお実装を導きたす。

プロゞェクトごずに䞀床だけ党䜓ルヌル(constitution)を定め、機胜ごずに 仕様化(specify) → 蚈画(plan) → タスク化(tasks) → 実装(implement) → 収束(converge) を行いたす。

゚ヌゞェントのチャットで、以䞋のスキルを呌び出したす:

/speckit-constitution Create principles focused on code quality, testing, and maintainability.
/speckit-specify Build a photo organizer with albums grouped by date and a tile preview of each album.
/speckit-plan Use Vite with vanilla JavaScript. Keep images local and store metadata in SQLite.
/speckit-tasks
/speckit-implement
/speckit-converge

収束結果が Converged ず報告されるたで、implement → converge を繰り返したす。远加の品質ゲヌトが必芁な堎合は、明確化・チェックリスト・䞀貫性分析を加えおください。

SDD実践ガむド · コマンドリファレンス

バグ修正

蚺断・修埩・怜蚌を分けおおくこずで、゚ヌゞェントが評䟡枈みの原因を修正し、元の症状が解消されたかを確認できるようにしたす。事前にSDDの機胜開発ワヌクフロヌを行う必芁はありたせん。

CLIセットアップ(タヌミナル): プロゞェクトディレクトリでオプトむン方匏の拡匵機胜をむンストヌルしたす:

specify extension add bug

次に、゚ヌゞェントのチャットで 評䟡(assess) → 修正(fix) → テスト(test) のスキルを呌び出したす:

/speckit-bug-assess "Submitting an empty password crashes the login form." slug=login-crash
/speckit-bug-fix slug=login-crash
/speckit-bug-test slug=login-crash

レポヌトは .specify/bugs/login-crash/ に保存されたす。最終的な刀定を確認しおください。 verified(怜蚌枈み)、partial(郚分的)、failed(倱敗)のいずれかです。怜蚌がないものは修正が成功したずは蚀えたせん。

バグ修正実践ガむド · コマンドリファレンス

アむデア評䟡

そのアむデアが゜フトりェアになるかどうかにかかわらず、アむデアを進めるず決める前に根拠を集めたす。この独立したプロセスは、゜ヌスコヌドが存圚しないプロゞェクトでも機胜したす。

CLIセットアップ(タヌミナル): プロゞェクトディレクトリでオプトむン方匏の拡匵機胜をむンストヌルしたす:

specify extension add assess

次に、゚ヌゞェントのチャットで 受付(intake) → 調査(research) → 定矩(define) → 具䜓化(shape) → 決定(decide) のスキルを呌び出したす:

/speckit-assess-intake "Let users work offline and sync when they reconnect." slug=offline-mode
/speckit-assess-research slug=offline-mode
/speckit-assess-define slug=offline-mode
/speckit-assess-shape slug=offline-mode
/speckit-assess-decide slug=offline-mode

成果物は .specify/assessments/offline-mode/ に保存され、最終的に 進める(go)・芁確認(needs-clarification)・䞭止(kill) の3択で結論が出たす。䞍明点を解消するには、ステヌゞ党䜓を再生成するのではなく、既存のMarkdown成果物を盎接、たたぱヌゞェントず䞀緒に修正しおください。go の決定が出お実際に開発する堎合は /speckit-specify に匕き継げたす。理由を明蚘した䞊で停止するこずも、有甚な結果の䞀぀です。

アむデア評䟡実践ガむド · コマンドリファレンス

プロセスをカスタマむズする、たたは自分自身のプロセスを持ち蟌む

拡匵機胜は新しい機胜を远加し、プリセットは既存の挙動を調敎し、ワヌクフロヌは手順を自動化し、バンドルはロヌルベヌスのセットアップをパッケヌゞ化したす。単発のテンプレヌト倉曎にはプロゞェクトロヌカルなオヌバヌラむドを䜿甚しおください。

カスタマむズガむド · コミュニティの拡匵機胜・プリセット・バンドル・りォヌクスルヌ

ドキュメント

スタヌ数の掚移

Spec Kitのスタヌ掚移チャヌト

Spec Kitを茝かせおくれる、すべおの皆さんに感謝したす。

サポヌトず貢献

バグを報告する、たたは機胜をリク゚ストする · コントリビュヌションガむド · 行動芏範

Spec KitはMITラむセンスの䞋で提䟛されおいたす。