diff --git a/README.ja.md b/README.ja.md new file mode 100644 index 0000000000..bf8046a3e8 --- /dev/null +++ b/README.ja.md @@ -0,0 +1,171 @@ +
+ Spec Kitロゴ +

🌱 Spec Kit

+

仕様で作る、バグを直す、アイデアを見極める ―― あなたのコーディングエージェントと共に。

+
+ +

+ 最新リリース + GitHub stars + ライセンス + ドキュメント +

+ +

+ English · + 简体中文 · + 日本語 +

+ +Spec Kitは、AIコーディングエージェントに構造化されたプロセス、再利用可能なテンプレート、記録に残る成果をもたらすオープンソースのツールキットです。以下の3つのプロセスのいずれかから始め、必要に応じてカスタマイズしたり、自分自身のプロセスを持ち込んだりすることもできます。 + +## 利用するプロセスを選択する + +| やりたいこと | プロセス | 成果 | +| --- | --- | --- | +| 機能やアプリケーションを構築する | [仕様駆動開発](#仕様駆動開発) | 計画・実装・収束を経て完成した仕様 | +| 不具合のある動作を診断し、修正する | [バグ修正](#バグ修正) | 評価された原因、範囲を絞った修正、記録された検証 | +| アイデアに投資する価値があるか判断する | [アイデア評価](#アイデア評価) | 根拠に基づく、進める(go)・要確認・中止のいずれかの決定 | + +これらは**独立したエントリーポイント**であり、必ず順番に実施する3段階のフェーズではありません。SDDはコアに同梱されています。バグ修正とアイデア評価は、必要なときにインストールするバンドル拡張機能です。 + + + + +## はじめる + +Linux、macOS、またはWindows上で、**Python 3.11以降**、**[uv](https://github.github.io/spec-kit/install/uv.html)**、および対応するAIコーディングエージェントが必要です。 +**CLIのみのセットアップ**を行う場合は、ターミナルで以下のコマンドを実行してSpec Kitをインストールし、プロジェクトを作成してください。 + +```bash +uv tool install specify-cli +specify init my-project --integration copilot +cd my-project +``` + + + +この例では **GitHub Copilotのデフォルトのスキルモード** を使用しています。他の対応エージェントを使う場合は、`copilot` をお使いのエージェントの[エージェント識別子](https://github.github.io/spec-kit/reference/integrations.html)に置き換えてください。 + +すでにコードがありますか？[既存プロジェクト向けガイド](https://github.github.io/spec-kit/guides/existing-projects.html)を参照してください。バージョン固定でのインストール、その他のインストーラー、CI、トラブルシューティングについては[インストールガイド](https://github.github.io/spec-kit/installation.html)を、既存のインストールを更新する場合は[アップグレードガイド](https://github.github.io/spec-kit/upgrade.html)を参照してください。 + +ここから**プロジェクトディレクトリでコーディングエージェントを起動し**、下記のいずれかのプロセスを選んでください。各 `/speckit-*` **スキルはエージェントのチャット内で**、1つずつ呼び出し、結果を確認してから次に進んでください。これらはターミナルコマンドではなく、エージェントのスキルです。エージェントやモードによっては、[異なる呼び出し方](https://github.github.io/spec-kit/reference/integrations.html#command-invocation)を使う場合があります。 + + + + +## 仕様駆動開発 + +作る **方法(how)** を決める前に、 **何を(what)・なぜ(why)** を定義します。SDDは要件を仕様・技術計画・実行可能なタスクへと変換し、それらの成果物に沿って実装を導きます。 + +**プロジェクトごとに一度だけ全体ルール(constitution)を定め、機能ごとに 仕様化(specify) → 計画(plan) → タスク化(tasks) → 実装(implement) → 収束(converge) を行います。** + +エージェントのチャットで、以下のスキルを呼び出します: + +```text +/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実践ガイド](https://github.github.io/spec-kit/quickstart.html) · +[コマンドリファレンス](https://github.github.io/spec-kit/reference/agentic-sdd.html) + + + + +## バグ修正 + +診断・修復・検証を分けておくことで、エージェントが評価済みの原因を修正し、元の症状が解消されたかを確認できるようにします。事前にSDDの機能開発ワークフローを行う必要はありません。 + +**CLIセットアップ(ターミナル):** プロジェクトディレクトリでオプトイン方式の拡張機能をインストールします: + +```bash +specify extension add bug +``` + +次に、エージェントのチャットで **評価(assess) → 修正(fix) → テスト(test)** のスキルを呼び出します: + +```text +/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`(失敗)のいずれかです。検証がないものは修正が成功したとは言えません。 + +[バグ修正実践ガイド](https://github.github.io/spec-kit/guides/bugfix.html) · +[コマンドリファレンス](https://github.github.io/spec-kit/reference/agentic-bugfix.html) + + + + +## アイデア評価 + +そのアイデアがソフトウェアになるかどうかにかかわらず、アイデアにコミットする前に根拠を集めます。この独立したプロセスは、ソースコードが存在しないプロジェクトでも機能します。 + +**CLIセットアップ(ターミナル):** プロジェクトディレクトリでオプトイン方式の拡張機能をインストールします: + +```bash +specify extension add assess +``` + +次に、エージェントのチャットで **受付(intake) → 調査(research) → 定義(define) → 具体化(shape) → 決定(decide)** のスキルを呼び出します: + +```text +/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` に引き継げます。理由を明記した上で停止することも、有用な結果の一つです。 + +[アイデア評価実践ガイド](https://github.github.io/spec-kit/guides/assessment.html) · +[コマンドリファレンス](https://github.github.io/spec-kit/reference/agentic-assessment.html) + + + + + +## プロセスをカスタマイズする、または自分自身のプロセスを持ち込む + +**拡張機能**は新しい機能を追加し、**プリセット**は既存の挙動を調整し、**ワークフロー**は手順を自動化し、**バンドル**はロールベースのセットアップをパッケージ化します。単発のテンプレート変更にはプロジェクトローカルなオーバーライドを使用してください。 + +[カスタマイズガイド](https://github.github.io/spec-kit/guides/customization.html) · +[コミュニティの拡張機能・プリセット・バンドル・ウォークスルー](https://github.github.io/spec-kit/community/overview.html) + + + + + + + + + + +## ドキュメント + +- [CLIリファレンス](https://github.github.io/spec-kit/reference/overview.html) と [プロセスコマンド](https://github.github.io/spec-kit/reference/agentic-sdd.html#command-overview) +- [SDDの理念](https://github.github.io/spec-kit/concepts/sdd.html)、[完全な方法論](./spec-driven.md)、[既存の仕様の進化](https://github.github.io/spec-kit/guides/evolving-specs.html) +- [紹介動画](https://github.github.io/spec-kit/quickstart.html#video-overview) と [プロジェクトの歴史](https://github.github.io/spec-kit/history.html) +- [Spec KitはSpec Kit自身をどう使っているか](./CONTRIBUTING.md#does-spec-kit-use-spec-kit) + + + +## サポートと貢献 + +[バグを報告する、または機能をリクエストする](https://github.com/github/spec-kit/issues/new) · +[コントリビューションガイド](./CONTRIBUTING.md) · [行動規範](./CODE_OF_CONDUCT.md) + + + +Spec Kitは[MITライセンス](./LICENSE)の下で提供されています。 diff --git a/README.md b/README.md index 2cd0045f4c..4f57e819c1 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,8 @@

English · - 简体中文 + 简体中文 · + 日本語

Spec Kit is an open source toolkit that gives AI coding agents structured diff --git a/README.zh-CN.md b/README.zh-CN.md index 3d7c069554..087696bb38 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -13,7 +13,8 @@

English · - 简体中文 + 简体中文 · + 日本語

Spec Kit 是一个开源工具套件，为 AI 编码助手提供结构化流程、可复用模板和有据可查的成果。