mcpField
P
project-docs-maintainer

project-docs-maintainer

github.com/gaelic-ghost開発65 回インストール
リポジトリ

project-docs-maintainer について

リポジトリ管理者向けのドキュメント保守スキルです。Skills README の監査とロードマップの確認・範囲を限定した更新を分け、編集前の読み取り専用確認と報告形式を定めています。

主な機能

  1. 01README の保守監査
  2. 02ロードマップの検証と整形
  3. 03編集前の読み取り専用確認
  4. 04モード別の更新範囲制限
  5. 05Markdown と JSON のレポート

活用シーン

  1. 01Skills リポジトリの README の問題確認
  2. 02チェックリスト形式の ROADMAP.md の検証
  3. 03確認済みドキュメント修正の適用
  4. 04ドキュメント変更後の状態確認

インストール

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

$npx skills add https://github.com/gaelic-ghost/productivity-skills --skill project-docs-maintainer

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

同梱ファイル

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

agents/
openai.yaml
config/
roadmap-customization.template.yaml
references/
checks-common.md
checks-js-ts.md
checks-python.md
checks-rust.md
checks-swift.md
discoverability-rules.md
fix-policies.md
output-contract.md
profile-model.md
roadmap-automation-prompts.md
roadmap-config-schema.md
roadmap-customization.md
section-schema.md
seed-artifacts.md
skills-readme-maintenance-automation-prompts.md
style-rules.md
verification-checklist.md
scripts/
roadmap_alignment_maintainer.py
skills_readme_maintenance.py
tests/
test_roadmap_alignment_maintainer.py
test_skills_readme_maintenance.py

詳細

プロジェクトドキュメントメンテナー

ドキュメントメンテナンスには標準のスキルエントリーポイントを使用し、該当するモードを選択します。

入力

  • mode=skills_readme_maintenance
    • 必須：--workspace <path>
    • 任意：--repo-glob <glob>、繰り返し指定可能な--exclude <path>、--apply-fixes
  • mode=roadmap_maintenance
    • 必須：--project-root <path>、--run-mode <check-only|apply>
    • 任意：--roadmap-path <path>
  • 新しいプロンプトでは標準のモード名を使用します。
  • skills_readme_alignmentは互換性維持の目的に限って扱います。

ワークフロー

  1. ユーザーの依頼に基づいて、標準のmodeを選択します。
  2. まず読み取り専用の処理を実行します。
    • skills_readme_maintenance：最初に監査します
    • roadmap_maintenance：最初に--run-mode check-onlyを指定します
  3. 検出結果を確認し、修正範囲を選択したモード内に限定します。
  4. ユーザーが編集を依頼している場合、対応する範囲限定の書き込み処理を実行します。
    • skills_readme_maintenance：--apply-fixes
    • roadmap_maintenance：--run-mode apply
  5. 同じモードを再実行し、残っている問題を確認します。
  6. モード固有のMarkdownおよびJSONレポート形式で返します。
skills_readme_maintenance
  • スクリプト：scripts/skills_readme_maintenance.py
  • 対象範囲：*-skillsリポジトリのREADME.mdメンテナンス
  • 参考資料：
    • references/output-contract.md
    • references/section-schema.md
    • references/discoverability-rules.md
    • references/profile-model.md
roadmap_maintenance
  • スクリプト：scripts/roadmap_alignment_maintainer.py
  • 対象範囲：チェックリスト形式のROADMAP.mdの検証、移行、範囲を限定した正規化
  • 参考資料：
    • references/roadmap-customization.md
    • references/roadmap-config-schema.md

出力仕様

  • skills_readme_maintenance
    • 次の項目を含むMarkdownとJSONを返します。
      • run_context
      • repos_scanned
      • profile_assignments
      • schema_violations
      • command_integrity_issues
      • fixes_applied
      • post_fix_status
      • errors
    • 問題もエラーもない場合は、No findings.のみを正確に出力します。
  • roadmap_maintenance
    • 次の項目を含むMarkdownとJSONを返します。
      • run_context
      • findings
      • apply_actions
      • errors
    • 検出結果も適用アクションもエラーもない場合は、No findings.のみを正確に出力します。

ガードレール

  • 自動コミット、自動プッシュ、PRの作成は行いません。
  • ソースコード、マニフェスト、ロックファイル、CIファイルは編集しません。
  • skills_readme_maintenanceでは、編集範囲をREADME.mdおよび明示的に承認されたAGENTS.mdへのスニペット挿入に限定します。
  • roadmap_maintenanceでは、applyモードで編集できるのは対象のROADMAP.mdのみです。
  • 非推奨のエイリアスを通常の手順に含めず、レガシープロンプトを扱う場合に限り言及します。

参考資料

  • references/output-contract.md
  • references/skills-readme-maintenance-automation-prompts.md
  • references/roadmap-automation-prompts.md
  • references/profile-model.md
  • references/section-schema.md
  • references/discoverability-rules.md
  • references/fix-policies.md
  • references/roadmap-customization.md
  • references/roadmap-config-schema.md

コメント

Markdown 対応