Spec-First Workflow
コードを記述する前に要件を定義します。
OpenSpecAIアシスタントのための仕様駆動開発
AIアシスタントプロジェクトの構築と管理のための軽量な仕様。
ようこそ。ここはOpenSpecに関するすべての情報が集まる場所です。
OpenSpecは、コードを記述する前に何を作るべきかについて、あなたとAIコーディングアシスタントが合意できるように支援します。あなたが変更点を説明すると、AIが短い仕様書とタスクリストをドラフトし、両者が同じ計画を確認してから作業が行われます。これで、「途中でAIが間違ったものを構築していた」という事態はなくなります。
他に何も読まない場合でも、この2つのページを読んでください。
/opsx:propose を実際にタイプする場所（ヒント：ターミナルではなくAIチャット内です）。これはほとんどの人が一度つまずくポイントです。後者（AIへのスラッシュコマンド）は、見た目以上に重要です。OpenSpecには2つの側面があります。ターミナルで実行するコマンドラインツールと、AIアシスタントに与えるスラッシュコマンドです。どちらがどれであるかを知っておくことで、最も一般的な混乱の瞬間を避けることができます。
まず身につけるべき最高の習慣：何を作るべきか確信が持てない場合は、
/opsx:exploreから始めてください。 これは、あなたのコードを読み込み、選択肢を検討し、アーティファクトやコードが存在する前に曖昧なアイデアを具体的な計画へと研ぎ澄ます思考パートナーです。Explore First ガイドがその根拠を示しています。
全くの初心者です。 Getting Started から始め、次に Core Concepts at a Glance をざっと見てください。何か不可解に感じた場合は、FAQ や Glossary が近くにあります。
問題はあるが計画がない状態です。 これは一般的なケースであり、専用の回答があります。Explore First を利用してください。コミットする前にAIと一緒に/opsx:exploreを使って熟考しましょう。
大規模な既存のコードベースを持っています。 すべてをドキュメント化する必要はありません。Using OpenSpec in an Existing Project は、海全体を煮詰めることなく、実際のブラウンフィールドコードから始める方法を示しています。
とにかく動作させたいです。 Install を実行し、openspec init を実行した後、最初のスラッシュコマンドが正しい場所で機能するようにHow Commands Workを読んでください。
例から学びたいです。 Examples & Recipes ページでは、小さなフィーチャー、バグ修正、リファクタリング、探索といった実際の変更を最初から最後まで解説します。
以前のワークフローからの移行者です。 Migration Guide は、何がどのように変わったのか、そしてなぜかを説明し、既存の作業が安全であることを保証します。
チームのプロセスに合わせて調整したいです。 Customization は、プロジェクトの設定、カスタムスキーマ、共有コンテキストをカバーしています。
何か壊れています。 Troubleshooting には、実際に人々が遭遇する失敗とその修正方法を集めています。
| Doc | 提供するもの |
|---|---|
| Getting Started | インストール、初期化、最初の変更をエンドツーエンドで実行する方法 |
| Explore First | コミットする前にアイデアを熟考するために /opsx:explore を使用する方法 |
| How Commands Work | スラッシュコマンドが動作する場所、"インタラクティブモード"の意味、ターミナルとチャットの違い |
| Core Concepts at a Glance | すべてのメンタルモデルを1ページにまとめたもの：仕様、変更、デルタ、アーカイブ |
| Installation | npm, pnpm, yarn, bun, Nix および動作確認方法 |
| Doc | 提供するもの |
|---|---|
| Workflows | 一般的なパターンと各コマンドをいつ使うべきか |
| Examples & Recipes | 実際の変更の完全なウォークスルー、コピー＆ペースト可能 |
| Using OpenSpec in an Existing Project | 大規模なブラウンフィールドコードへのOpenSpec導入方法 |
| Editing & Iterating on a Change | アーティファクトの更新、戻る、手動編集の調整 |
| Commands | すべての /opsx:* スラッシュコマンドのリファレンス |
| CLI | すべての openspec ターミナルコマンドのリファレンス |
| Doc | 提供するもの |
|---|---|
| Concepts | 仕様、変更、アーティファクト、スキーマ、アーカイブに関する詳細な説明 |
| OPSX Workflow | なぜワークフローがフェーズロックではなく流動的であるか、およびアーキテクチャの詳細解説 |
| Glossary | 定義されているすべての用語集 |
| Doc | 提供するもの |
|---|---|
| Customization | プロジェクトの設定、カスタムスキーマ、共有コンテキスト |
| Multi-Language | 英語以外の言語でアーティファクトを生成する方法 |
| Supported Tools | OpenSpecが統合する25以上のAIツールとファイルの配置先 |
| Doc | 提供するもの |
|---|---|
| FAQ | 人々が最も尋ねる質問へのクイックアンサー |
| Troubleshooting | 具体的な失敗に対する具体的な修正方法 |
| Migration Guide | レガシーワークフローからOPSXへの移行方法 |
| Doc | 提供するもの |
|---|---|
| Stores: User Guide | 作業が複数のリポジトリやチームにまたがる場合の計画方法 |
| Agent Contract | エージェントが駆動する機械可読なCLIサーフェス |
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← optional, but a great habit
4. Propose (in your AI chat) /opsx:propose add-dark-mode
5. Build (in your AI chat) /opsx:apply
6. Archive (in your AI chat) /opsx:archiveステップ1と2はターミナルで行われます。残りはAIアシスタントのチャットで行われます。この分割こそ覚えておくべきことであり、How Commands Work がその理由を正確に説明しています。ステップ3はオプションですが、確信が持てないときに/opsx:exploreから始めることが最も身につけるべき習慣です。
openspec feedback "your message" は、ターミナルから直接フィードバックを送信します（GitHub Issue を開きます）。これらのドキュメントに誤り、陳腐化しているもの、または混乱を招くものはありましたか？それはバグです。Issue または PR を開いてください。ドキュメンテーションの改善は、あなたができる最も価値のある貢献の一つです。