メインコンテンツまでスキップ

ワークフロー (Workflows)

ワークフローは、AIエージェントと連携する際のソフトウェア開発ステップを自動化し、ガイドする標準化されたプロセスです。AIDKのワークフローは .agent/workflows/ ディレクトリ（またはご使用のIDE固有のディレクトリ）にあります。スラッシュコマンド（例: /new-requirement, /execute-plan）を使用して呼び出すことができます。

メインフロー: /new-requirement​

/new-requirementは、新機能のドキュメントを作成および管理するためのコアワークフローです。このプロセスにより、コードを書き始める前に、機能が徹底的に分析、設計、計画されることが保証されます。

目的​

  • 標準化されたドキュメント: 要件定義から計画まで、機能を適切にドキュメント化します。
  • エラーの最小化: AIがアーキテクチャや実行手順を提案する前に、要件を詳細に分析します。
  • 追跡可能性の確保: 各機能が固有のドキュメントを有するため、相互チェック（クロスチェック）が容易になります。

/new-requirement の手順​

  1. 要件の取得 (Capture Requirement) AIが基本情報を要求します。機能名（ケバブケース、例: user-authentication）、解決する問題、対象ユーザー、および主要なユーザーストーリーなどです。

  2. 機能ドキュメント構造の作成 (Create Feature Documentation Structure) テンプレートから特定の機能に必要なファイル構造を作成します。

    • docs/ai/requirements/feature-{name}.md
    • docs/ai/design/feature-{name}.md
    • docs/ai/planning/feature-{name}.md
    • docs/ai/implementation/feature-{name}.md
    • docs/ai/testing/feature-{name}.md

  3. 要件定義フェーズ (Requirements Phase) docs/ai/requirements/feature-{name}.md に以下を書き込みます: 問題の定義、目標／対象外の目標、ユーザーストーリー、成功基準、制約事項、および未解決の質問。

  4. 設計フェーズ (Design Phase) docs/ai/design/feature-{name}.md に以下を設計します: アーキテクチャの変更、データモデル、API/インターフェース、コンポーネント、設計上の決定、セキュリティおよびパフォーマンスの考慮事項。

  5. 計画フェーズ (Planning Phase) docs/ai/planning/feature-{name}.md で作業を細分化します: タスクとサブタスクの分解、依存関係、見積もり、実装順序、およびリスク。

  6. ドキュメントのレビュー (Documentation Review) AIが /review-requirements, /review-design, /review-implementation を自動的に実行し、作成されたドキュメントを検証・評価します。

  7. 次のステップ (Next Steps) このコマンドはドキュメント作成に特化しています。実装の準備ができたら、/execute-plan を使用し、AIに計画されたタスクを実行させます。

その他の重要なワークフロー​

/new-requirementに加えて、AIDKは強力なワークフローのシステムを提供しています：

スラッシュコマンド目的
/execute-plan機能計画をタスクごとに段階的に実行します。
/debugコードを変更する前に、根本原因（ルートコーズ）を深く分析します。
/code-review設計に対するプッシュ前の徹底的なコードレビューを行います。
/write-tests新機能の信頼性を確保するためのテストを追加します。
/update-docsREADMEやDocusaurusサイトを最新の変更と同期します。
/check-implementation実装されたコードを要件や設計と比較して検証します。