engram-docs-alignment について
engram-docs-alignment は、プロジェクトのドキュメントを実装済みの動作に合わせるスキルです。コード変更と同時にドキュメントを更新し、検証する手順を示します。
主な機能
- 01現在の動作を記述
- 02コード変更に合わせた文書更新
- 03公開前の例の検証
- 04ルート、パス、コマンドの確認
活用シーン
- 01API やセットアップ手順の変更
- 02CLI コマンドや例の更新
- 03コントリビューター向けガイドの作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/engram-docs-alignmentを入力して読み込まれたか確認します。
詳細
使用する場面
以下の場合にこのスキルを使用します。
- API、セットアップフロー、またはプラグインの動作を変更する場合
- CLI コマンドやサンプルを更新する場合
- コントリビューター向けのガイダンスを作成する場合
整合性のルール
- ドキュメントには、想定される動作ではなく、現在の動作を記載します。
- コードの変更と同じ PR でドキュメントを更新します。
- 公開前にサンプルを検証します。
- 非推奨のファイル、エンドポイント、またはスクリプトへの記述を削除します。
検証
- エンドポイント名がサーバーのルートと一致している
- スクリプト名がリポジトリ内のパスと一致している
- コマンドのサンプルが記載どおりに実行できる
- エージェント間の注記が現在も正確である
コメント
Markdown 対応