Skip to content

OpenSpecAI アシスタント向け仕様駆動開発

AI アシスタントプロジェクトの構築と管理のための軽量な仕様。

OpenSpec ドキュメント ​

ようこそ。ここは OpenSpec のすべてが集まる場所です。

OpenSpec は、あなたと AI コーディングアシスタントがコードを書く前に何を構築するかについて合意することを助けます。変更を説明すると、AI が短い仕様とタスクリストを作成し、両者が同じ計画を確認した上で作業が進みます。途中で AI が間違ったものを作っていたことに気づく、ということがなくなります。

もしこれ以外のページを読まないとしても、この 2 ページは読んでください。

  1. Getting Started:インストール、初期化、そして最初の变更を完了する。
  2. How Commands Work:/opsx:propose を実際にどこで入力するか(ヒント:ターミナルではなく、AI チャット内)。これにほぼ全員が一度はつまずきます。

2 番目のページは、見た目以上に重要です。OpenSpec には 2 つの側面があります。ターミナルで実行するコマンドラインツールと、AI アシスタントに与えるスラッシュコマンドです。どちらがどちらかを知っておくことで、最も一般的な混乱を避けられます。

最初に身につけるべき最高の習慣:何を作ればよいか迷ったら、/opsx:explore から始めることです。 これはリスクのない思考パートナーで、あなたのコードを読み、選択肢を比較し、具体的な計画に磨き上げる前に、まだ成果物やコードが存在しない段階で曖昧なアイデアを明確にします。Explore First ガイドでその理由を説明しています。

パスを選択する ​

まったくの初心者です。 Getting Started から始めて、次に Core Concepts at a Glance をざっと読みましょう。何か不思議に思うことがあれば、FAQ と Glossary がすぐそばにあります。

問題はあるが計画はない。 これは最も一般的なケースで、専用の回答があります:Explore First。/opsx:explore を使って、何かをコミットする前に AI と一緒に考えましょう。

大きな既存のコードベースがあります。 すべてをドキュメント化する必要はありません。Using OpenSpec in an Existing Project では、既存のブラウンフィールドコードでどのように始めるかを示しています。

とにかく動かしたいだけ。 Install を読んで openspec init を実行し、次に How Commands Work を読んで、最初のスラッシュコマンドが正しい場所に届くようにします。または、AI-assisted install prompt でセットアップをアシスタントに任せます。

例から学びたい。 Examples & Recipes では、小さな機能追加、バグ修正、リファクタリング、探索など、実際の变更を最初から最後まで通しで解説しています。

AI が計画を起草した — 次は? 読みましょう。Reviewing a Change では、コードを書く前に間違った方向を捉える 2 分のチェックパスを示し、Writing Good Specs では承認に値する計画の構成要素を説明しています。

チームで作業している。 OpenSpec on a Team では、変更がブランチやプルリクエストにどのように対応するか、チームメイトがコードの前に計画をどのようにレビューするかを示しています。

旧ワークフローから移行してきた。 Migration Guide では、何が変更され、なぜ変更されたかを説明し、既存の作業が安全であることを保証します。

チームのプロセスに合わせてカスタマイズしたい。 Customization では、プロジェクト設定、カスタムスキーマ、共有コンテキストを扱います。

何か壊れている。 Troubleshooting では、実際に遭遇する障害とその修正方法をまとめています。

全体マップ ​

ここから始める ​

Doc得られるもの
Getting Startedインストール、初期化、そして最初の变更をエンドツーエンドで実行
Explore Firstコミットする前に /opsx:explore でアイデアを検討
How Commands Workスラッシュコマンドの実行場所、「対話モード」の意味、ターミナルとチャットの違い
Core Concepts at a Glance1 ページで全体像を把握:仕様、変更、差分、アーカイブ
Installationnpm、pnpm、yarn、bun、Nix、AI アシスタントにセットアップを任せるプロンプト、動作確認方法

日常的に使う ​

Doc得られるもの
Workflows一般的なパターンと、どのコマンドを使うかの判断基準
Examples & Recipes実際の变更の完全なウォークスルー、そのままコピー&ペースト可能
Writing Good Specs強力な要件とシナリオの書き方、変更の適切なサイズ調整
Reviewing a Changeコードを書く前に起草された計画に対する 2 分のチェックパス
OpenSpec on a Team変更がブランチ、プルリクエスト、レビューにどう組み込まれるか
Using OpenSpec in an Existing Project大規模なブラウンフィールドコードベースへの OpenSpec の導入
Editing & Iterating on a Change成果物の更新、戻り、手動編集の調整
Commandsすべての /opsx:* スラッシュコマンドのリファレンス
CLIすべての openspec ターミナルコマンドのリファレンス

深く理解する ​

Doc得られるもの
Concepts仕様、変更、成果物、スキーマ、アーカイブの長文解説
OPSX Workflowワークフローがフェーズ固定ではなく流動的な理由、アーキテクチャの深掘り
Glossaryすべての用語を 1 か所で定義

自分好みにする ​

Doc得られるもの
Customizationプロジェクト設定、カスタムスキーマ、共有コンテキスト
Multi-Language英語以外の言語で成果物を生成
Supported ToolsOpenSpec が統合する 30 以上の AI ツールと、ファイルの保存場所
Community ShowcaseOpenSpec で構築されたプロジェクトとリソース

ヘルプが必要なとき ​

Doc得られるもの
FAQよくある質問への素早い回答
Troubleshooting具体的な障害に対する具体的な修正方法
Migration Guideレガシーワークフローから OPSX への移行

リポジトリ間を調整する(ベータ) ​

Doc得られるもの
Stores: User Guide作業がリポジトリやチームをまたぐ場合、専用のリポジトリで計画
Agent Contractエージェントが操作するマシン可読の CLI インターフェース

30 秒バージョン ​

text
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 から始めることは、最も価値のある習慣です。

ヘルプを得るその他の場所 ​

  • Discord: discord.gg/YctCnvvshC で質問、アイデア、ヘルプ。
  • GitHub Issues: github.com/Fission-AI/OpenSpec/issues でバグと機能リクエスト。
  • openspec feedback "your message" でターミナルから直接フィードバックを送信(GitHub Issue が開かれます)。

これらのドキュメントで誤り、古い情報、または分かりにくい箇所を見つけたら、それはバグです。Issue または PR を開いてください。ドキュメントの改善は、最も価値のある貢献の一つです。