mcpField
O
openwiki-update

openwiki-update

github.com/kinensake開発639 回インストール16 週間前に更新
リポジトリ

openwiki-update について

リポジトリの変更に応じて既存の OpenWiki ドキュメントを更新するスキルです。Git の情報から古くなったページを特定し、広範な書き直しではなく対象を絞った編集を行います。

主な機能

  1. 01前回更新以降の変更検出
  2. 02ソース変更と対象ページの対応付け
  3. 03文書の限定的な編集
  4. 04ルートのエージェント指示確認
  5. 05更新メタデータの記録

活用シーン

  1. 01Wiki ページをコード変更に合わせて維持
  2. 02不要な文書の書き直しを回避
  3. 03影響を受けたクイックスタートリンクの更新
  4. 04Wiki が最新かどうかの確認

インストール

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

$npx skills add https://github.com/kinensake/openwiki-skills --skill openwiki-update

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

同梱ファイルreferences/core.md

詳細

Wiki の更新

最近のリポジトリの変更後も正確な状態を保てるように、既存の openwiki/ ドキュメントを更新します。更新は必要最小限にし、ソースの変更によって古くなった箇所のみを変更してください。

最初に、このスキルのディレクトリにある references/core.md を読んでください。出力に適用する品質ルール、構造要件、セキュリティルール、AGENTS.md／CLAUDE.md の参照テンプレートが定義されています。

openwiki/quickstart.md が存在しない場合は、ここで中止し、先に /openwiki-init を実行するようユーザーに伝えてください。呼び出し時に追加の指示があった場合は、何もしないかどうかの確認を省略し、その指示を更新の根拠として扱ってください。

ワークフロー

  1. 何もしない場合の確認。 openwiki/.last-update.json を読みます。次の条件がすべて満たされている場合は、リポジトリに前回の更新以降の変更が検出されなかったことを報告して、何も編集せずに終了します。

    • メタデータに gitHead が記録されている。
    • git status --short --untracked-files=all が空である（openwiki/.last-update.json 自体は無視する）。
    • git rev-parse HEAD が記録された gitHead と一致するか、git diff --name-only <gitHead>..HEAD のすべてのパスが openwiki/ 内にあり、その一覧が空ではない。

  2. Git の根拠を収集。 git status --short、git rev-parse HEAD、git diff --name-status HEAD を実行します。前回の正常終了後に追加されたコミットを確認します。git log <lastGitHead>..HEAD --name-status --oneline を優先し、gitHead が記録されていない場合は git log --since <updatedAt> を、メタデータ自体がない場合は直近 20 件のコミットを使います。変更内容を把握するため、影響の大きいコミットには git show を使います。

  3. ドキュメントへの影響計画を作成。 変更されたソースファイルを基に、ソースの変更 → 影響を受けるドキュメント → 必要な編集 → 理由を整理します。編集前に、影響を受ける openwiki/ ページを読みます。関連するソース、ワークフロー、製品、既存ドキュメントの変更と結び付けられないページは編集しないでください。

  4. 必要最小限の編集を適用。 次の制約に従ってください。

    • 正確なままの有用な構成や文言は維持します。段落を追加するより、古くなった一文を置き換えることを優先してください。
    • 最近の変更によって内容が不正確、不完全、または誤解を招くページだけを編集します。すべてのページを更新しないでください。
    • 各コンセプトの説明は正規のページ 1 つにまとめ、他のページでの言及は簡潔にするか、リンクのみにします。
    • 書式だけの編集は禁止です。表の再整形、空行の調整、ソース一覧の並べ替え、変更中の内容の正確性に関わらない文言の推敲は行わないでください。
    • ソースの変更によって重大な誤りとなった場合を除き、Source Map セクション、Git の根拠一覧、一般的な「注意事項」セクションは更新しないでください。
    • 特定のコミットが重要な歴史的判断を説明する場合を除き、コミットハッシュの一覧を継続的に記録したり更新したりしないでください。
    • 差分の目安： 変更されたソースファイルが約 5 件未満の場合、更新する wiki ページは最大 1～2 ページにします。製品のトップレベルの動作、セットアップ、またはナビゲーションが変更されていない限り、quickstart は編集しないでください。3 ページを超える wiki ページの編集が必要だと思われる場合は、広範囲な変更が妥当な理由を慎重に検討してください。
    • 影響計画で必要とされた場合にのみ、古くなったページの更新、不足ページの追加、廃止された説明の削除、quickstart のリンク修正を行います。
    • 更新が何もしない結果になることもあります。wiki がすでに正確であれば、ファイルを編集せず、wiki は最新であると伝えてください。

  5. ルートのエージェント指示ファイルを確認。 トップレベルの AGENTS.md／CLAUDE.md にある OpenWiki の参照セクションを確認し、欠落している場合、または意味的に古くなっている場合にのみ更新します（正確なテンプレートは core.md を参照）。wiki が最新の場合も、この確認は必須です。

  6. 実行メタデータを記録。 openwiki/ の内容を変更した場合に限り、openwiki/.last-update.json を "command": "update" にして書き換えます（形式は core.md を参照）。

最後に、変更したページとその理由をまとめてください。変更がなかった場合は、wiki がすでに最新であることを伝えてください。

コメント

Markdown 対応