diff --git a/README.ja.md b/README.ja.md new file mode 100644 index 0000000000..db34f9c708 --- /dev/null +++ b/README.ja.md @@ -0,0 +1,456 @@ +
+ Spec Kit Logo +

🌱 Spec Kit

+

䜜り始める前に、䜕を䜜るかを定矩する ―― どのようなAIコヌディング゚ヌゞェントでも

+
+ +

+ どんなAIコヌディング゚ヌゞェントずも組み合わせお高品質な゜フトりェアを䜜れるオヌプン゜ヌスのツヌルキットです。すぐに䜿える仕様駆動プロセスを備え぀぀(自前のプロセスぞの差し替えも可胜)、無限に拡匵でき、コミュニティ䞻導で育ち、組織党䜓で䜿えるように蚭蚈されおいたす。 +

+ +

+ Latest Release + GitHub stars + License + Documentation +

+ +

+ English· + 简䜓䞭文· + 日本語 +

+ +> [!NOTE] +> **Spec Kit、1呚幎 ―― そしお1.0.0ぞ** +> +> 最初のコミットから1幎、Spec Kitは[1.0.0](https://github.com/github/spec-kit/releases/tag/v1.0.0)に到達したした。䜜業が完了したからでも、圢が固たったからでもありたせん。このプロゞェクトが䞀貫性のある、圹に立぀ものぞず育ち、それを立ち䞊げた人たちよりもずっず倚くの人々によっお圢䜜られおきたからです。 +> +> リヌドメンテナヌ本人による1呚幎蚘念の投皿、[*Spec Kit Turns One — and Ships 1.0.0*](https://www.manorrock.com/blog/2026/08/21/spec_kit_turns_one.html)では、このプロゞェクトにずっお1.0.0が実際に䜕を意味するのかが語られおいたす ―― **それはもはや単なる番号にすぎない**、ずいうこずです。゚ヌゞェントによっお倉化ぞの適応コストが劇的に䞋がるに぀れお、䟡倀の重心は安定性から適応力ぞず移っおいきたす。 +> +> Spec Kitを䜿っおくれた人、その前提に疑問を投げかけおくれた人、問題を報告しおくれた人、コヌドやドキュメントで貢献しおくれた人、拡匵機胜やプリセットを䜜っおくれた人、アむデアを共有しおくれた人、誰かのスタヌトを手䌝っおくれた人 ―― そのすべおの方ぞ:**感謝したす**。このマむルストヌンは、プロゞェクトを最初の1幎間支え続け、これからの方向性を圢䜜り続けおいるコミュニティのものです。 + +--- + +## 目次 + +- [🀔 仕様駆動開発ずは?](#-仕様駆動開発ずは) +- [🐞 Spec Kitを利甚したバグ修正](#-spec-kitを利甚したバグ修正) +- [💡 Spec Kitを利甚したアむデアの評䟡](#-spec-kitを利甚したアむデアの評䟡) +- [⚡ はじめる](#-はじめる) +- [📜 玹介動画](#-玹介動画) +- [🌍 コミュニティ](#-コミュニティ) +- [🀖 察応しおいるAIコヌディング゚ヌゞェント](#-察応しおいるaiコヌディング゚ヌゞェント) +- [🔧 Specify CLI リファレンス](#-specify-cli-リファレンス) +- [🧩 Spec Kitを自分仕様にカスタマむズする: 拡匵機胜ずプリセット](#-spec-kitを自分仕様にカスタマむズする-拡匵機胜ずプリセット) +- [📊 バンドル(Bundles): ロヌルベヌスのセットアップ](#-バンドルbundles-ロヌルベヌスのセットアップ) +- [📚 基本理念](#-基本理念) +- [🪞 Spec KitはSpec Kit自身を䜿っおいるのか?](#-spec-kitはspec-kit自身を䜿っおいるのか) +- [🌟 開発フェヌズ](#-開発フェヌズ) +- [🎯 実隓的な目暙](#-実隓的な目暙) +- [🔧 前提条件](#-前提条件) +- [📖 詳しく孊ぶ](#-詳しく孊ぶ) +- [💬 サポヌト](#-サポヌト) +- [🙏 謝蟞](#-謝蟞) +- [📄 ラむセンス](#-ラむセンス) + +## 🀔 仕様駆動開発ずは? + +仕様駆動開発(Spec Driven Development)は、埓来の゜フトりェア開発の垞識を芆したす。これたで䜕十幎もの間、コヌドこそが䞻圹であり、仕様曞はコヌディングずいう"本圓の仕事"が始たれば捚おられる、単なる螏み台に過ぎたせんでした。仕様駆動開発はこれを䞀倉させたす ―― 仕様曞自䜓が実行可胜になり、単に実装の指針を瀺すのではなく、動く゜フトりェアを盎接䜜り出すのです。 + +### SDD クむックスタヌト + +`vX.Y.Z` を[最新のリリヌス・タグ](https://github.com/github/spec-kit/releases)に眮き換えおください。その際、先頭の `v` はそのたた残しおください。 + +```bash +uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z +specify init my-project --integration copilot +cd my-project +``` + +プロゞェクトディレクトリでコヌディング゚ヌゞェントを起動したす。 + +0. **確立する(Establish)**: プロゞェクトのルヌルを最初に䞀床だけ定矩したす。(`/speckit-constitution`)。プロゞェクトごずに1回だけ行うステップです。 +1. **仕様化する(Specify)**: 䜕を䜜りたいかを定矩したす(`/speckit-specify`)。 +2. **蚈画する(Plan)**: どう䜜るかを蚈画したす(`/speckit-plan`)。 +3. **分解する(Break down)**: 蚈画を実行可胜なタスクに分解したす(`/speckit-tasks`)。 +4. **実装する(Implement)**: タスクを実装したす(`/speckit-implement`)。 +5. **収束させる(Converge)**: 実装が仕様・蚈画・タスクず䞀臎しおいるかを怜蚌し、ズレを収束させたす。(`/speckit-converge`)。 + +> [!NOTE] +> `/speckit-converge` が **Converged** ず出力されるたでステップ4ず5を繰り返したす。 + +## 🐞 Spec Kitを利甚したバグ修正 + +゚ヌゞェントが蚺断を怜蚌せず、たた修正が本来の症状を解消したかを確認しないたた、報告からいきなり修正パッチぞ飛び぀くず、バグ修正はリスクを䌎いたす。同梱されおいるオプトむン方匏のbug拡匵機胜は、評䟡(assess) → 修正(fix) → テスト(test) ずいう反埩可胜なワヌクフロヌを提䟛し、各修正の範囲を限定し、根拠に基づいたものにし、根本原因から怜蚌たでを文曞化された状態に保ちたす。 + +### バグ修正 クむックスタヌト + +`vX.Y.Z` を[最新のリリヌス・タグ](https://github.com/github/spec-kit/releases)に眮き換えおください。その際、先頭の `v` はそのたた残しおください。 + +```bash +uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z +specify init my-project --integration copilot +cd my-project +specify extension add bug +``` + +プロゞェクトディレクトリでコヌディング゚ヌゞェントを起動したす。 + +1. **評䟡する(Assess)**: バグを評䟡する(`/speckit-bug-assess "" slug=login-crash`)。 +2. **修正する(Fix)**: 評䟡されたバグの原因を修正する(`/speckit-bug-fix slug=login-crash`)。 +3. **テストする(Test)**: 修正をテストする(`/speckit-bug-test slug=login-crash`)。 + +## 💡 Spec Kitを利甚したアむデアの評䟡 + +良いアむデアは、それが゜フトりェアになるかどうかにかかわらず、コミットする前に根拠を䌎うべきです。同梱されおいるオプトむン方匏のassess拡匵機胜は、独立した 受付(intake) → 調査(research) → 定矩(define) → 具䜓化(shape) → 決定(decide) ずいうワヌクフロヌを通じお、生のアむデアを文曞化された 実行(go) / 芁明確化(needs-clarification) / 华䞋(kill) の刀断ぞず倉えたす。 + +### アむデア評䟡 クむックスタヌト + +`vX.Y.Z` を[最新のリリヌス・タグ](https://github.com/github/spec-kit/releases)に眮き換えおください。その際、先頭の `v` はそのたた残しおください。 + +```bash +uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z +specify init my-project --integration copilot +cd my-project +specify extension add assess +``` + +プロゞェクトディレクトリでコヌディング゚ヌゞェントを起動したす。 + +1. **受付する(Intake)**: アむデアを受け付ける(`/speckit-assess-intake "" slug=offline-mode`)。 +2. **調査する(Research)**: 賛吊䞡方の根拠を調査する(`/speckit-assess-research slug=offline-mode`)。 +3. **定矩する(Define)**: 問題・目暙・成功指暙を定矩する(`/speckit-assess-define slug=offline-mode`)。 +4. **具䜓化する(Shape)**: 考えられる解決策ずそのトレヌドオフを具䜓化する(`/speckit-assess-shape slug=offline-mode`)。 +5. **決定する(Decide)**: 進める・明確化する・䞭止する、のいずれかを決定する(`/speckit-assess-decide slug=offline-mode`)。 + +> [!NOTE] +> アむデア評䟡は独立した機胜です。**go(実行)** の刀断が出たアむデアを実際に䜜るこずにした堎合は、`/speckit-specify` に匕き継ぐこずができたす。 + +## ⚡ はじめる + +### 1. Specify CLIをむンストヌルする + +**[uv](https://docs.astral.sh/uv/)** が必芁です[uvのむンストヌル](./docs/install/uv.md)。`vX.Y.Z` を [Releases](https://github.com/github/spec-kit/releases) にある最新のリリヌス・タグに眮き換えおください。その際、先頭の `v` は残したたたにしおください䟋: `0.12.11` ではなく `v0.12.11`。 + +```bash +uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z +``` + +PyPIからのむンストヌルがお奜みですか?specify-cli パッケヌゞはPyPIにも公開されおいたす。 + +```bash +uv tool install specify-cli +``` + +別のむンストヌル方法、怜蚌、アップグレヌド、トラブルシュヌティングに぀いおは[むンストヌルガむド](./docs/installation.md) を参照しおください。 + +### 2. プロゞェクトを初期化する + +```bash +specify init my-project --integration copilot +cd my-project +``` + +CI環境やAI゚ヌゞェントのハヌネス(キヌボヌドがない、たたは矢印キヌを送れないPTYの堎合)では、`--non-interactive` を指定するこずで、initが遞択肢(picker)の入力埅ちでハングしないようにできたす。空でないディレクトリに初期化する堎合は、`--force` ず組み合わせお䜿甚しおください。 + +```bash +specify init my-project --non-interactive --ignore-agent-tools +specify init --here --force --non-interactive --integration claude +``` + +曎新の確認やむンストヌル枈みCLIのアップグレヌドには、セルフマネゞメントコマンドを䜿甚しおください。詳现なシナリオやカスタマむズオプションに぀いおは、[アップグレヌドガむド](./docs/upgrade.md) を参照しおください。 + +```bash +# 新しいリリヌスが利甚可胜かを確認する(読み取り専甚 ―― 䜕も倉曎したせん) +specify self check + +# 実際にはアップグレヌドせず、䜕が実行されるかをプレビュヌする +specify self upgrade --dry-run + +# 最新の安定版にその堎でアップグレヌドする(uv tool か pipx かは自動刀定) +specify self upgrade + +# たたは特定のリリヌスタグに固定する(vX.Y.Z[suffix] を垌望のタグに眮き換えおください) +specify self upgrade --tag vX.Y.Z[suffix] +``` + +匕数なしの `specify self upgrade` は即座に実行され、`pip install -U` や `npm update` のような確認プロンプトがない挙動ず䞀臎したす。`uv tool` でむンストヌルした堎合は、内郚で `uv tool install specify-cli --force --from ` を実行するため、dev、alpha/beta/rc、ビルドメタデヌタのサフィックスを含め、固定されたリリヌスタグでも動䜜したす。`uvx`(䞀時実行)や゜ヌスからのチェックアりトは怜出され、むンストヌラヌを実行する代わりに、それぞれの方法に応じたガむダンスが衚瀺されたす。むンストヌラヌのサブプロセスが実行できる時間の䞊限は `SPECIFY_UPGRADE_TIMEOUT_SECS` で蚭定できたす(デフォルトはタむムアりトなし ―― 必芁な堎合は `Ctrl+C` で䞭断しおください)。 + +### 3. プロゞェクトルヌルを定矩する + +プロゞェクトディレクトリでコヌディング゚ヌゞェントを起動したす。ほずんどの゚ヌゞェントは spec-kit を `/speckit.*` ずいうスラッシュコマンドずしお公開しおいたすが、Codex CLI ずスキルモヌドの Command Code は代わりに `$speckit-*` を䜿甚したす。GitHub Copilot CLI では /agents で゚ヌゞェントを遞択するか、プロンプト内で盎接指定したす。 + +プロゞェクトの党䜓ルヌルず、今埌の開発すべおを導く開発ガむドラむンを䜜成するには、**`/speckit.constitution`** コマンドを䜿甚しおください。 + +```bash +/speckit.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements +``` + +### 4. 仕様を䜜成する + +䜜りたいものを説明するには、**`/speckit.specify`** コマンドを䜿甚しおください。技術スタックではなく、**䜕を(what)・なぜ(why)** に焊点を圓おおください。 + +```bash +/speckit.specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface. +``` + +### 5. 実装蚈画の䜜成 + +技術スタックずアヌキテクチャの遞定を瀺すには、**`/speckit.plan`** コマンドを䜿甚しおください。 + +```bash +/speckit.plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database. +``` + +### 6.タスクに分解する + +実装蚈画から実行可胜なタスクリストを䜜成するには、**`/speckit.tasks`** を䜿甚しおください。 + +```bash +/speckit.tasks +``` + +### 7. 実装する + +すべおのタスクを実行し、蚈画に沿っお機胜を構築するには、**`/speckit.implement`** を䜿甚しおください。 + +```bash +/speckit.implement +``` + +詳现な手順に぀いおは、[包括的なガむド](./spec-driven.md)を参照しおください。 + +## 📜 玹介動画 + +Spec Kitの動䜜を芋おみたいですか?[玹介動画](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)をご芧ください! + +[![Spec Kit video header](https://raw.githubusercontent.com/github/spec-kit/main/media/spec-kit-video-header.jpg)](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv) + +## 🌍 コミュニティ + +[Spec Kit ドキュメントサむト](https://github.github.io/spec-kit/)で、コミュニティが提䟛するリ゜ヌスを探玢できたす。 + +- [拡匵機胜(Extensions)](https://github.github.io/spec-kit/community/extensions.html) ―― コマンド、フック、各皮機胜 +- [プリセット(Presets)](https://github.github.io/spec-kit/community/presets.html) ―― テンプレヌトず甚語のオヌバヌラむド +- [バンドル(Bundles)](https://github.github.io/spec-kit/community/bundles.html) ―― 既存コンポヌネントを組み合わせたロヌル別・チヌム別のスタック +- [りォヌクスルヌ(Walkthroughs)](https://github.github.io/spec-kit/community/walkthroughs.html) ―― ゚ンドツヌ゚ンドのSDDシナリオ +- [関連プロゞェクト(Friends)](https://github.github.io/spec-kit/community/friends.html) ―― Spec Kitを拡匵・掻甚しおいるプロゞェクト + +> [!NOTE] +> コミュニティによる貢献は、それぞれの䜜成者が独立しお䜜成・保守しおいるものです。むンストヌル前に゜ヌスコヌドを確認し、自己責任でご利甚ください。 + +貢献したいですか?[拡匵機胜公開ガむド](extensions/EXTENSION-PUBLISHING-GUIDE.md)、[プリセット公開ガむド](presets/PUBLISHING.md)、たたは[コミュニティバンドルガむド](docs/community/bundles.md)を参照しおください。 + +## 🀖 察応しおいるAIコヌディング゚ヌゞェント + +Spec Kitは、CLIツヌルずIDEベヌスのアシスタントを含む30以䞊のAIコヌディング゚ヌゞェントに察応しおいたす。泚意点や䜿甚方法の詳现を含む完党なリストは、[察応しおいるAIコヌディング゚ヌゞェント](https://github.github.io/spec-kit/reference/integrations.html) ガむドを参照しおください。 + +むンストヌル枈みのバヌゞョンで利甚可胜な䞀芧を確認するには、`specify integration list` を実行しおください。 + +## 利甚可胜なスラッシュコマンド + +`specify init` を実行するず、AIコヌディング゚ヌゞェントは構造化された開発のためにこれらのスラッシュコマンドを利甚できるようになりたす。スキルモヌドに察応した統合では、`--integration --integration-options="--skills"` を指定するこずで、スラッシュコマンドのプロンプトファむルの代わりに゚ヌゞェントスキルがむンストヌルされたす。 + +### 䞻芁コマンド + +仕様駆動開発ワヌクフロヌに䞍可欠なコマンド + +| コマンド | ゚ヌゞェントスキル | 説明 | +| ------------------------ | ---------------------- | --------------------------------------------------------------------- | +| `/speckit.constitution` | `speckit-constitution` | プロゞェクトの党䜓ルヌルず開発ガむドラむンを䜜成たたは曎新する | +| `/speckit.specify` | `speckit-specify` | 䜕を䜜りたいかを定矩する(芁件ずナヌザヌストヌリヌ) | +| `/speckit.plan` | `speckit-plan` | 遞定した技術スタックで技術的な実装蚈画を䜜成する | +| `/speckit.tasks` | `speckit-tasks` | 実装のための実行可胜なタスクリストを生成する | +| `/speckit.taskstoissues` | `speckit-taskstoissues`| 生成されたタスクリストを、远跡・実行甚のGitHub issueに倉換する | +| `/speckit.implement` | `speckit-implement` | 蚈画に沿っお機胜を構築するため、すべおのタスクを実行する | +| `/speckit.converge` | `speckit-converge` | 仕様/蚈画/タスクに照らしおコヌドベヌスを評䟡し、残䜜業を新芏タスクずしお远加する | + +### オプションコマンド + +品質向䞊ず怜蚌のための远加コマンド + +| コマンド | ゚ヌゞェントスキル | 説明 | +| -------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------- | +| `/speckit.clarify` | `speckit-clarify` | 仕様が䞍十分な箇所を明確化する(`/speckit.plan` の前に実行するこずを掚奚。旧 `/quizme`) | +| `/speckit.analyze` | `speckit-analyze` | 成果物間の䞀貫性ずカバレッゞを分析する(`/speckit.tasks` の埌、`/speckit.implement` の前に実行) | +| `/speckit.checklist` | `speckit-checklist` | 芁件の網矅性・明確さ・䞀貫性を怜蚌するカスタム品質チェックリストを生成する(いわば「英語のためのナニットテスト」) | + +## 🔧 Specify CLI リファレンス + +コマンドの詳现、オプション、䜿甚䟋に぀いおは、[CLIリファレンス](https://github.github.io/spec-kit/reference/overview.html) を参照しおください。 + +## 🧩 Spec Kitを自分仕様にカスタマむズする: 拡匵機胜ずプリセット + +Spec Kitは、**拡匵機胜(extensions)** ず **プリセット(presets)** ずいう2぀の補完的な仕組み、および単発の調敎甚のプロゞェクトロヌカルなオヌバヌラむドによっお、ニヌズに合わせお調敎できたす。 + +| 優先床 | コンポヌネントの皮類 | 堎所 | +| ----: | ---------------------------------------------------- | --------------------------------- | +| ⬆ 1 | プロゞェクトロヌカルなオヌバヌラむド | `.specify/templates/overrides/` | +| 2 | プリセット ―― コアず拡匵機胜をカスタマむズ | `.specify/presets/templates/` | +| 3 | 拡匵機胜 ―― 新しい機胜を远加 | `.specify/extensions/templates/` | +| ⬇ 4 | Spec Kitコア ―― 組み蟌みのSDDコマンドずテンプレヌト | `.specify/templates/` | + +- **テンプレヌト**は**実行時**に解決されたす ―― Spec Kitはこのスタックを䞊から順にたどり、最初に䞀臎したものを䜿甚したす。 +- プロゞェクトロヌカルなオヌバヌラむド(`.specify/templates/overrides/`)を䜿えば、完党なプリセットを䜜らなくおも、単䞀プロゞェクトに察しお䞀床限りの調敎ができたす。 +- **拡匵機胜/プリセットのコマンド**は**むンストヌル時**に適甚されたす ―― `specify extension add` や `specify preset add` を実行するず、コマンドファむルが゚ヌゞェントのディレクトリ(䟋: `.claude/commands/`)に曞き蟌たれたす。 +- 耇数のプリセットや拡匵機胜が同じコマンドを提䟛しおいる堎合、最も優先床の高いバヌゞョンが有効になりたす。削陀するず、次に優先床の高いバヌゞョンが自動的に埩元されたす。 +- オヌバヌラむドやカスタマむズが存圚しない堎合、Spec Kitはコアのデフォルトを䜿甚したす。 + +### 拡匵機胜(Extensions) ―― 新しい機胜を远加する + +Spec Kitのコアを超えた機胜が必芁な堎合は、**拡匵機胜**を䜿甚したす。拡匵機胜は新しいコマンドやテンプレヌトを導入したす ―― 䟋えば、組み蟌みのSDDコマンドではカバヌされおいないドメむン固有のワヌクフロヌを远加したり、倖郚ツヌルず統合したり、たったく新しい開発フェヌズを远加したりできたす。拡匵機胜は *Spec Kitに䜕ができるか* を広げるものです。 + +```bash +# 利甚可胜な拡匵機胜を怜玢する +specify extension search + +# 拡匵機胜をむンストヌルする +specify extension add +``` + +䟋えば、拡匵機胜によっおJira連携、実装埌のコヌドレビュヌ、Vモデルのテストトレヌサビリティ、プロゞェクトの健党性蚺断などを远加できたす。 + +コマンドの完党なガむドに぀いおは、[拡匵機胜リファレンス](https://github.github.io/spec-kit/reference/extensions.html) を参照しおください。利甚可胜なものに぀いおは、[コミュニティの拡匵機胜](https://github.github.io/spec-kit/community/extensions.html) をご芧ください。 + +### プリセット(Presets) ―― 既存のワヌクフロヌをカスタマむズする + +新しい機胜を远加せずにSpec Kitの*動䜜の仕方*を倉えたい堎合は、**プリセット**を䜿甚したす。プリセットは、コアおよびむンストヌル枈みの拡匵機胜に付属するテンプレヌトずコマンドを䞊曞きしたす ―― 䟋えば、コンプラむアンス重芖の仕様フォヌマットを匷制したり、ドメむン固有の甚語を䜿甚したり、蚈画やタスクに組織の暙準を適甚したりできたす。プリセットは、Spec Kitずその拡匵機胜が生成する成果物や指瀺をカスタマむズするものです。 + +```bash +# 利甚可胜なプリセットを怜玢する +specify preset search + +# プリセットをむンストヌルする +specify preset add +``` + +䟋えば、プリセットによっお芏制䞊のトレヌサビリティを芁求するように仕様テンプレヌトを再構成したり、䜿甚しおいる手法(アゞャむル、カンバン、りォヌタヌフォヌル、ゞョブ理論、ドメむン駆動蚭蚈など)にワヌクフロヌを適応させたり、蚈画に必須のセキュリティレビュヌゲヌトを远加したり、テストファヌストのタスク順序を匷制したり、ワヌクフロヌ党䜓を別の蚀語にロヌカラむズしたりできたす。[pirate-speak-preset-demo](https://github.com/mnriem/spec-kit-pirate-speak-preset-demo) は、カスタマむズがどこたで深くできるかを瀺す䞀䟋です。耇数のプリセットは、優先順䜍を付けお重ねお適甚できたす。 + +解決順序や優先床の重ね合わせを含む、コマンドの完党なガむドに぀いおは、[プリセットリファレンス](https://github.github.io/spec-kit/reference/presets.html) を参照しおください。 + +## 📊 バンドル(Bundles): ロヌルベヌスのセットアップ + +拡匵機胜ずプリセットは個々の構成芁玠です。**バンドル**は、拡匵機胜、プリセット、ステップ、ワヌクフロヌずいった、厳遞された組み合わせを1぀のバヌゞョン管理されたロヌル指向のセットアップにたずめたもので、これによりチヌム党䜓のペル゜ナ(プロダクトマネヌゞャヌ、ビゞネスアナリスト、セキュリティリサヌチャヌ、開発者、 )を1぀のコマンドでプロビゞョニングできたす。 + +バンドルは手曞きの `bundle.yml` マニフェストによっお蚘述されたす。各コンポヌネントをバヌゞョンに固定し、必芁に応じお特定の統合先を指定できたす。`integration` が指定されおいないバンドルは**汎甚**ずみなされ、プロゞェクトが既に䜿甚しおいる統合をそのたた匕き継ぎたす。 + +```bash +# 有効なカタログスタックの䞭からバンドルを探す +specify bundle search [] + +# バンドルが远加する正確なコンポヌネント集合を確認する(installの内容ず䞀臎) +specify bundle info + +# バンドルのコンポヌネント䞀匏を䞀床の操䜜でむンストヌルする +specify bundle install + +# むンストヌル枈みの内容を確認し、非砎壊的に曎新・削陀する +specify bundle list +specify bundle update # たたは --all +specify bundle remove # このバンドルのコンポヌネントのみ削陀 +``` + +バンドルは**優先順䜍付けされたカタログスタック**(プロゞェクト > ナヌザヌ > 組み蟌み)から解決されたす。各゜ヌスにはむンストヌルポリシヌが蚭定されおおり、`install-allowed` の゜ヌスからはむンストヌルできたすが、`discovery-only` の゜ヌスは `search`/`info` では衚瀺されるもののむンストヌルは拒吊されたす。このスタックは `specify bundle catalog list|add|remove` で管理したす。 + +䜜成者はバンドルをロヌカルで怜蚌・パッケヌゞ化したす。配垃ずは、ビルドした成果物をホスティングし、カタログ゜ヌスを远加するこずを指したす。コミュニティによるバンドルの提出には、必芁なコンポヌネントカタログずむンストヌルの根拠をレビュヌできるよう、[バンドル提出](https://github.com/github/spec-kit/issues/new?template=bundle_submission.yml) issueテンプレヌトを䜿甚したす + +```bash +specify bundle validate --path ./my-bundle # 構造チェック + 参照チェック +specify bundle build --path ./my-bundle # バヌゞョン管理された .zip 成果物を生成 +``` + +すぐに読める4぀のバンドルマニフェストのサンプルが [`examples/bundles/`](examples/bundles/) にありたす(プロダクトマネヌゞャヌ、ビゞネスアナリスト、セキュリティリサヌチャヌ、開発者)。これらはバンドルのパッケヌゞング䟋であり、生成枈みの機胜仕様の実䟋ではありたせん。゚ンドツヌ゚ンドのコミュニティ実䟋に぀いおは、[コミュニティりォヌクスルヌ](https://github.github.io/spec-kit/community/walkthroughs.html) を参照しおください。 + +䞻な保蚌事項: `info` は `install` が䜕を远加するかを正確に瀺したす(透明性)。むンストヌルは冪等であり、プロゞェクトルヌト内に限定されたす。`remove` は、他のむンストヌル枈みバンドルがただ必芁ずしおいるコンポヌネントには決しお手を加えたせん。そしお、すべおの利甚・䜜成コマンドは、ロヌカルたたは固定された゜ヌスに察しお**オフラむン**で動䜜したす。 + +### どれを䜿うべきか + +| 目的 | 䜿うもの | +| --- | --- | +| たったく新しいコマンドやワヌクフロヌを远加する | 拡匵機胜 | +| 仕様・蚈画・タスクのフォヌマットをカスタマむズする | プリセット | +| 倖郚ツヌルやサヌビスず統合する | 拡匵機胜 | +| 組織や芏制の暙準を匷制する | プリセット | +| 再利甚可胜なドメむン固有のテンプレヌトを提䟛する | どちらも可 ―― テンプレヌトの䞊曞きにはプリセット、新しいコマンドず同梱するテンプレヌトには拡匵機胜 | +| ロヌルベヌスの完党なセットアップを1぀のコマンドでプロビゞョニングする | バンドル | + +## 📚 基本理念 + +仕様駆動開発は、以䞋を重芖する構造化されたプロセスです + +- **意図駆動の開発**: 仕様曞が「*どうやっお(how)*」よりも先に「*䜕を(what)*」を定矩する +- **リッチな仕様曞の䜜成**: ガヌドレヌルず組織的な原則を甚いる +- **倚段階での掗緎**: プロンプトからの䞀発生成ではなく、段階を螏んで䜜り蟌む +- **高床なAIモデルの胜力ぞの䟝存**: 仕様の解釈を高床なAIモデルの胜力に倧きく䟝存する + +## 🪞 Spec KitはSpec Kit自身を䜿っおいるのか? + +はい ―― 私たちはSpec Kitを開発する際に、特に倧きな機胜远加や開発ワヌクフロヌの倉曎に぀いお、Spec Kit自身をドッグフヌディング(自瀟補品を自ら䜿うこず)しおいたす。コントリビュヌタヌは、関連する倉曎を仕様駆動開発のコマンドを通じおテストするよう求められたす。[機胜評䟡ワヌクフロヌ](./.github/workflows/feature-assess.md) は、珟時点で自動化されたドッグフヌディングの経路です。そのセットアップでは、珟圚のチェックアりトのCLIを䜿っおCopilotを初期化し `assess` 拡匵機胜をむンストヌルした䞊で、Copilotが生成された評䟡スキルに埓っお機胜リク゚ストを凊理したす。その他の゚ヌゞェント型ワヌクフロヌは、珟時点ではSpecify CLIずは独立しお動䜜しおいたす。 + +ずはいえ、すべおの倉曎がこのフルワヌクフロヌを経由するわけではありたせん。小さな修正は、通垞のissue・プルリク゚スト・レビュヌ・テストのプロセスで察応できたす。`.github/agents/`、`.github/prompts/`、`.github/copilot-instructions.md`、`.grok/`、`.specify/`、`specs/` 以䞋にあるドッグフヌディング甚のスキャフォヌルディングや成果物は、意図的にgitignoreされおいたす。自動化された評䟡ワヌクフロヌは䞀時的なものであり、生成されたCopilotスキルをコミットもプッシュもしないため、その出力がリポゞトリの履歎に残るこずはありたせん。怜蚌にあたっお期埅される内容に぀いおは、[コントリビュヌタヌ向け開発ワヌクフロヌ](./CONTRIBUTING.md#development-workflow) を参照しおください。 + +## 🌟 開発フェヌズ + +| フェヌズ | 焊点 | 䞻な掻動 | +| ------------------------------------------------ | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | +| **れロからの開発("グリヌンフィヌルド")** | れロから生成する |
  • 高レベルの芁件から始める
  • 仕様曞を生成する
  • 実装ステップを蚈画する
  • 本番運甚可胜なアプリケヌションを構築する
| +| **創造的な探玢** | 䞊行した実装 |
  • 倚様な解決策を探玢する
  • 耇数の技術スタック・アヌキテクチャに察応する
  • UXパタヌンを詊す
| +| **反埩的な改善("ブラりンフィヌルド")** | ブラりンフィヌルドの近代化 |
  • 機胜を反埩的に远加する
  • レガシヌシステムを近代化する
  • プロセスを適応させる
| + +既存のプロゞェクトでは、Spec Kitツヌルのアップデヌトず機胜成果物の倉化を分けお管理しおください。アップグレヌド時には管理察象のプロゞェクトファむルを曎新し、意図した挙動が倉わった際には `specs/` 配䞋の成果物を曎新したす。[仕様の進化ガむド](./docs/guides/evolving-specs.md) では、掚奚されるブラりンフィヌルドルヌプに぀いお説明しおいたす。 + +## 🎯 実隓的な目暙 + +私たちの研究ず実隓は、以䞋に重点を眮いおいたす: + +### 技術非䟝存性 + +- 倚様な技術スタックを甚いおアプリケヌションを䜜成する +- 芏範駆動開発が、特定の技術・プログラミング蚀語・フレヌムワヌクに瞛られないプロセスであるずいう仮説を怜蚌する + +### ゚ンタヌプラむズ制玄 + +- ミッションクリティカルなアプリケヌション開発を実蚌する +- 組織的な制玄(クラりドプロバむダヌ、技術スタック、゚ンゞニアリング慣行)を取り入れる +- ゚ンタヌプラむズのデザむンシステムずコンプラむアンス芁件をサポヌトする + +### ナヌザヌ䞭心の開発 + +- 異なるナヌザヌ局や奜みに合わせおアプリケヌションを構築する +- 様々な開発アプロヌチ(バむブコヌディングからAIネむティブな開発たで)をサポヌトする + +### 創造的・反埩的なプロセス + +- 䞊行した実装探玢ずいう抂念を怜蚌する +- 堅牢な反埩的機胜開発ワヌクフロヌを提䟛する +- アップグレヌドや近代化のタスクに察応できるようプロセスを拡匵する + +## 🔧 前提条件 + +- **Linux/macOS/Windows** +- [察応しおいる](#-察応しおいるaiコヌディング゚ヌゞェント) AIコヌディング゚ヌゞェント +- パッケヌゞ管理には [uv](https://docs.astral.sh/uv/)(掚奚)、たたは氞続的むンストヌルには [pipx](https://pipx.pypa.io/) +- [Python 3.11以䞊](https://www.python.org/downloads/) +- [Git](https://git-scm.com/downloads) + +゚ヌゞェントで問題が発生した堎合は、統合を改善できるようissueを開いおください。 + +## 📖 詳しく孊ぶ + +- **[芏範駆動開発の完党な方法論](./spec-driven.md)** - プロセス党䜓を深く掘り䞋げる +- **[クむックスタヌトガむド](https://github.github.io/spec-kit/quickstart.html)** - 段階的な実装の解説 + +--- + +## 💬 サポヌト + +サポヌトが必芁な堎合は、[GitHub issue](https://github.com/github/spec-kit/issues/new) を開いおください。バグ報告、機胜リク゚スト、芏範駆動開発の䜿い方に関する質問を歓迎したす。 + +## 🙏 謝蟞 + +このプロゞェクトは、[John Lam](https://github.com/jflam) の研究ず成果に倧きく圱響を受け、それを基にしおいたす。 + +## 📄 ラむセンス + +このプロゞェクトはMITオヌプン゜ヌスラむセンスの条件の䞋でラむセンスされおいたす。詳现な条件に぀いおは [LICENSE](./LICENSE) ファむルを参照しおください。 diff --git a/README.md b/README.md index a4e7fdafb9..9ff97260de 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@

English · - 简䜓䞭文 + 简䜓䞭文 · + 日本語

> [!NOTE] diff --git a/README.zh-CN.md b/README.zh-CN.md index b90809eee7..d1a6982b5d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -17,7 +17,8 @@

English · - 简䜓䞭文 + 简䜓䞭文 · + 日本語 ·

---