Communitygithub.com

docmd — エージェントスキル(開発者向け)

AIエージェントがdocmdドキュメンテーションフレームワーク自体を理解し、修正・拡張するためのモジュール式スキルセットです。

docmd — エージェントスキル(開発者向け) とは?

このスキルは、AIエージェント(Claude Code、Cursor、Codexなど)がdocmdフレームワークの内部開発を行う際に使用します。ユーザーがdocmdのモノレポ内で作業している、プラグインやテンプレートを作成したい、エンジンを拡張したい場合などに自動的に読み込まれます。 このスキルは `npx docmd-skills dev <dir>` コマンドでインストールされ、既存の `docmd-skills/` の横に `docmd-dev/` ディレクトリを追加します。参照ファイル(APIリファレンス、プラグイン開発ガイド、テンプレート開発ガイド、エンジンリファレンス)を提供し、開発ワークフロー(モノレポのクローン、プラグイン作成、テンプレート作成、エンジン作業)をステップバイステップで案内します。 docmdのサイト設定や運用には使用せず、代わりに `docmd-skills`(ユーザー向け)スキルをデフォルトとします。このスキルはフレームワークそのものの改造に特化しており、モノレポの `packages/` 配下のソースコードを直接編集する開発者の作業を支援します。

対応~Claude Code~Codex CLI~Cursor
npx skills add docmd-io/docmd-skills

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

docmd — エージェントスキル(開発者向け) は何をしますか?

このスキルは、ユーザーがdocmdフレームワーク自体を変更したい場合に使用します。サイトを利用する側ではありません。このスキルは npx docmd-skills dev <dir> で読み込まれ、既存の docmd-skills/ インストールの横に docmd-dev/ を追加します。

このスキルを使うタイミング

以下のいずれかのシグナルが真の場合に使用します。

  1. ユーザーの現在のワーキングディレクトリがdocmdモノレポのクローンである。ローカルクローンのディレクトリ名は単に docmd/ です(GitHubのパスは docmd-io/docmd/)。目印: pnpm-lock.yaml、packages/core/src/、packages/ui/src/、packages/api/src/、packages/plugins/<name>/、packages/engines/。クローン方法: git clone https://github.com/docmd-io/docmd.git docmd && cd docmd。
  2. ユーザーが明示的に「プラグインを書きたい」「テンプレートを書きたい」「エンジンを拡張したい」「コアを修正したい」「フックを追加したい」などと言った場合。
  3. ユーザーがdocmdモノレポの packages/core/src/、packages/api/src/、packages/ui/src/、packages/plugins/*/src/、packages/engines/*/ 内のファイルを編集している場合。

ユーザーがフレームワークのヘルプを希望しているが、ワーキングディレクトリに docmd/ クローンが存在しない場合、何かをする前に、モノレポのクローン(git clone https://github.com/docmd-io/docmd.git docmd)または既存のクローンの更新(git -C docmd pull)を希望するかどうかを確認してください。最新のローカルクローンなしにフレームワークのソースを編集し始めないでください。

以下の場合には使用しないでください:サイトレベルの設定や操作(docmd-skillsを使用)、またはページのプローズ品質(docmd-writerを使用)。

読み込みルール

  • このスキルは、ユーザーがdocmdモノレポ内で積極的に作業している場合、またはフレームワーク内部について明示的に質問した場合にのみ読み込みます。
  • 不明な場合は、デフォルトで docmd-skills(ユーザー向け)を使用します。このスキルに切り替えることは、ユーザーがモノレポに対して pnpm コマンドを実行することに抵抗がないことを意味します。

リファレンス一覧

各行がリファレンスファイルです。CLI列は、どのインストールサブコマンドがこのファイルを追加するかを示します。

リファレンスCLIインストールサブコマンド用途
references/api-dev.mddocmd-skills devフレームワーク作成者向け公開Node API: EngineLoader、URL utilities、createActionDispatcher、TemplateSlot、フック/アクションの契約
references/plugin-development.mddocmd-skills devdocmdプラグインの作成: パッケージ構造、マニフェスト、apply()ライフサイクル、template機能、フック、テスト
references/template-development.mddocmd-skills devdocmdテーマ/テンプレートの作成: 12のテンプレートスロット、アセットパイプライン、manifest.json、テンプレートプラグイン
references/engines.mddocmd-skills devJS vs Rustビルドエンジン、エンジンの切り替え、エンジン固有の設定、パフォーマンストレードオフ

ワークフロー

1. モノレポのクローンまたは更新

クローン未作成 — クローンしてインストール:

git clone https://github.com/docmd-io/docmd.git docmd
cd docmd
pnpm install

既存のクローンあり — 更新し、必要に応じて依存関係を再インストール:

git -C docmd pull
pnpm install

決定前にクローンが古くなっていないか確認するには、git -C docmd status(「Your branch is behind」を確認)または git -C docmd log -1 --oneline を実行し、https://github.com/docmd-io/docmd/commits/main と比較します。

ローカルクローンのディレクトリは docmd/ です(docmd-io/docmd/ ではありません)。その中には、このスキル全体で参照される標準パッケージレイアウトがあります。

2. プラグインの作成

  1. スキャフォールディングの前に references/plugin-development.md を最初から最後まで読んでください。
  2. packages/plugins/<name>/ にある最も近い既存プラグインを選び、その構造をコピーします。
  3. references/api-dev.md で Plugin 型、フック名、0.8.7で導入されたtemplate機能を相互参照します。
  4. プラグイン独自の tests/ 以下にテストを追加します。モノレポの pnpm prep がユニバーサルフェイルセーフを実行します。

3. テンプレートの作成

  1. 12のテンプレートスロットとアセットパイプラインについて references/template-development.md を読んでください。
  2. 既存のテンプレート(packages/templates/summer/ がリファレンス)で使用されているマニフェスト構造に合わせます。
  3. references/api-dev.md で TemplateSlot ユニオンを検証します(header スロットはありません — 12個です)。

4. エンジン作業

  1. まず references/engines.md を読んでください。対象とするエンジンとその設定キーを確認します。
  2. エンジンローダーのNodeレベルでの変更については、references/api-dev.md の「エンジンローダーAPI」セクションを参照してください。

スキル間のナビゲーション

  • docmd-skills — サイトレベルの作業用。デフォルトで最初に読み込みます。
  • docmd-writer — テンプレートのデモやサンプルドキュメント内のプローズ品質に関わる場合に読み込みます。

関連スキル