mcpField
G
gds-document-project

gds-document-project

github.com/bmad-code-org開発26244 回インストール5 週間前に更新
リポジトリ

gds-document-project について

gds-document-projectは、AI向けのコンテキストを整えるために既存プロジェクトを文書化するBMadワークフローです。プロジェクト文書の作成に用いられ、インストール済みの手順に従って実行します。

主な機能

  1. 01AI向けに既存プロジェクトを文書化
  2. 02プロジェクト文書作成のワークフロー
  3. 03設定可能なコミュニケーション言語
  4. 04インストール済み手順に沿った実行

活用シーン

  1. 01既存プロジェクトの文書作成
  2. 02AI利用に向けたプロジェクトコンテキストの準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/bmad-code-org/bmad-module-game-dev-studio --skill gds-document-project

インストール後、Claude Code で/gds-document-projectを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

checklist.md
customize.toml
documentation-requirements.csv
instructions.md
templates/
deep-dive-template.md
index-template.md
project-overview-template.md
project-scan-report-schema.json
source-tree-template.md
workflows/
deep-dive-instructions.md
deep-dive-workflow.md
full-scan-instructions.md
full-scan-workflow.md

詳細

プロジェクトのドキュメント作成ワークフロー

目標: AI のコンテキストとして利用できるよう、既存プロジェクトのドキュメントを作成します。

あなたの役割: プロジェクトのドキュメント作成スペシャリストです。

  • すべての応答を {communication_language} で行ってください。

パス

  • installed_path = {skill-root}
  • instructions = {installed_path}/instructions.md
  • validation = {installed_path}/checklist.md
  • documentation_requirements_csv = {installed_path}/documentation-requirements.csv

規約

  • 裸のパス(例:template.md)は、スキルのルートから解決されます。
  • {skill-root} は、このスキルがインストールされているディレクトリ(customize.toml がある場所)を示します。
  • {project-root} は、プロジェクトの作業ディレクトリから親ディレクトリをさかのぼって最初に見つかる、_bmad/ を含むフォルダーを示します。
  • {skill-name} は、スキルディレクトリのベース名を示します。

アクティベーション時

ステップ 1:ワークフローブロックを解決する

実行:uv run {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --project-root {project-root} --key workflow

スクリプトが失敗した場合は、次の 3 つのファイルをベース → チーム → ユーザーの順に読み込み、リゾルバーと同じ構造マージルールを適用して、workflow ブロックを手動で解決してください。

  1. {skill-root}/customize.toml — デフォルト
  2. {project-root}/_bmad/custom/{skill-name}.toml — チームによる上書き
  3. {project-root}/_bmad/custom/{skill-name}.user.toml — 個人による上書き

存在しないファイルはスキップします。スカラー値は上書きし、テーブルはディープマージします。code または id をキーとするテーブルの配列では、一致する項目を置き換え、新しい項目を追加します。それ以外の配列はすべて追記します。

ステップ 2:前置ステップを実行する

続行する前に、{workflow.activation_steps_prepend} の各項目を順番に実行します。

ステップ 3:永続的な事実を読み込む

{workflow.persistent_facts} の各項目を、このワークフロー実行中に保持する基本コンテキストとして扱います。file: で始まる項目は、{project-root} 配下のパスまたはグロブとして扱い、参照先の内容を事実として読み込みます。それ以外の項目は、記載どおりの事実として扱います。

ステップ 4:設定を読み込む

{project-root}/_bmad/gds/config.yaml から設定を読み込み、次の項目を解決します。

  • user_name
  • communication_language
ステップ 5:ユーザーに挨拶する

{user_name} に、{communication_language} で挨拶します。

ステップ 6:後置ステップを実行する

{workflow.activation_steps_append} の各項目を順番に実行します。

アクティベーションが完了しました。activation_steps_prepend または activation_steps_append が空でなかった場合は、すべての項目を順番どおりに実行したことを確認してから続行してください。すべてのアクティベーションステップが完了するまで、メインワークフローを開始しないでください。

実行

{installed_path}/instructions.md を最後まで読み、内容に従ってください。

コメント