mcpField
O
openwiki-init

openwiki-init

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

openwiki-init について

openwiki-init は、リポジトリの `openwiki/` に初期ドキュメント一式を作るスキルです。コーディングエージェントによる調査、ページ計画と執筆、構成の確認、エージェント指示と実行メタデータの更新を案内します。

主な機能

  1. 01Git 履歴とリポジトリ状態の確認
  2. 02コード、文書、テスト、運用情報の棚卸し
  3. 03絞り込んだ Wiki ページ群の計画
  4. 04クイックスタートと関連ページの作成
  5. 05Wiki 構成の確認と実行メタデータの記録

活用シーン

  1. 01リポジトリの初期ドキュメントを作成
  2. 02人間や後続のコーディングエージェント向けにコードベースを整理
  3. 03既存文書を Wiki にまとめる

インストール

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

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

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

同梱ファイルreferences/core.md

詳細

Wiki 初期化

このリポジトリの人間と今後のコーディングエージェントの両方に役立つ初回版のドキュメントを、openwiki/ 以下に生成します。

まず、このスキルのディレクトリにある references/core.md を読んでください。すべての出力が従うべき品質ルール、構成要件、セキュリティルール、および AGENTS.md/CLAUDE.md の参照テンプレートが定義されています。

これは初回のドキュメント作成です。openwiki/ に有用なドキュメントはまだないものとして、構成を一から作成してください。呼び出し時にユーザーから追加の指示があった場合、このルールの範囲内でそちらを優先してください。

ワークフロー

  1. Git のコンテキストを収集します。 git status --short、git rev-parse HEAD、git log --max-count=20 --name-status --oneline、git diff --name-status HEAD を実行して、リポジトリの現在の状態と最近の変化を把握します。

  2. リポジトリのインベントリを作成します。 既存のドキュメント、アプリケーションのエントリーポイント、パッケージ/設定ファイル、主要なドメインフォルダー、テスト/評価、データ/スキーマファイル、スキル/プレイブックファイル、運用スクリプトを調べます。core.md に記載された調査方針に従ってください。複数の重要なドメインがあるリポジトリでは、読み取り専用の調査サブエージェントを使用してください。最近のコミットや、重要度の高いファイルに対する対象を絞った git blame/git show などの Git の証拠を使い、重要なワークフローがどのように構築されたかを把握します。

  3. 執筆前に計画を立てます。 作成予定の Wiki ページ、その各ページの根拠となる情報源、未解決の疑問を列挙した計画を作成します。計画はリポジトリ内に残さず、作業メモまたはリポジトリ外の一時ファイル(環境で利用できる場合はスクラッチパッドや一時ディレクトリなど)に保管してください。openwiki/ 内に計画ファイルを残してはいけません。ページ数は絞り、クイックスタートと、リポジトリを明確に説明するために必要な最小限のセクションページに留めてください。リポジトリが明らかに小規模な場合を除き、最大 8 ページとします。

  4. ドキュメントを作成します。 まず openwiki/quickstart.md を作成し、次にリンク先のセクションページを作成します。既存のドキュメントが充実している場合、Wiki はそれらの重複ではなく、方針に基づく案内と要約として作成してください。すべてのソースファイルを説明しようとせず、主要なアーキテクチャ、ワークフロー、ドメイン概念、データモデル、連携、運用、テスト、既知の拡張ポイントを適切な粒度で取り上げてください。

  5. ツリーを確認します。 core.md のセクション品質ルールに照らして openwiki/ のツリーを再確認し、価値の低い単一ファイルのディレクトリや内容が不十分なページを統合、移動、または削除します。

  6. ルートのエージェント指示ファイルを更新します。 AGENTS.md/CLAUDE.md に core.md の OpenWiki 参照セクションをそのまま追加します。

  7. 実行メタデータを記録します。 core.md の形式に従い、"command": "init" を指定して openwiki/.last-update.json に記録します。

最後に、作成したドキュメントと重要な注意点または未解決の疑問をまとめます。正確で見通しのよい初回版 Wiki を作成したら作業を終了してください。後続の /openwiki-update の実行で改善できます。

コメント