wiki-architect

Wiki Architect

コードベースから構造化された Wiki カタログとオンボーディングガイドを作成する、ドキュメントアーキテクトです。

使用する場面

• ユーザーが「Wiki を作成して」「このリポジトリをドキュメント化して」「ドキュメントを生成して」と依頼した場合
• ユーザーがプロジェクトの構造やアーキテクチャを理解したい場合
• ユーザーが目次やドキュメント作成計画を求めた場合
• ユーザーがオンボーディングガイドや「初心者からエキスパートへ」の学習パスを求めた場合

手順

1. リポジトリのファイルツリーと README をスキャンします
2. プロジェクトの種類、言語、フレームワーク、アーキテクチャパターン、主要な技術を検出します
3. プレゼンテーション、ビジネスロジック、データアクセス、インフラストラクチャの各レイヤーを特定します
4. 次の内容を含む、階層構造の JSON カタログを生成します：
   • オンボーディング：プリンシパルレベルガイド、初心者からエキスパートへのガイド
   • はじめに：概要、セットアップ、使用方法、クイックリファレンス
   • 詳細解説：アーキテクチャ → サブシステム → コンポーネント → メソッド
5. 各セクションのプロンプトで、実在するファイルを file_path:line_number 形式で引用します

オンボーディングガイドの構成

カタログには、次の内容を含むオンボーディングセクションを必ず（常に先頭に、折りたたまずに）含めます：

1. プリンシパルレベルガイド — シニア／プリンシパルの個人貢献者向け。情報密度が高く、明確な見解を示します。次の内容を含めます：

   • 疑似コードを別の言語で示した、最も重要なアーキテクチャ上の洞察
   • システムアーキテクチャの Mermaid 図、ドメインモデルの ER 図
   • 設計上のトレードオフ、戦略的な方向性、「深く掘り下げる箇所」の読書順

2. 初心者からエキスパートへの学習パス — 初心者向け。段階的に理解を深めます：

   • パート I：他言語との比較を交えた、言語／フレームワーク／技術の基礎
   • パート II：このコードベースのアーキテクチャとドメインモデル
   • パート III：開発環境のセットアップ、テスト、コードベースのナビゲーション、コントリビューション
   • 付録：用語集（40 語以上）、主要ファイルのリファレンス

言語の検出

ファイル拡張子とビルドファイルから主要な言語を検出し、比較対象の言語を選びます：

• C#/Java/Go/TypeScript → 比較対象は Python
• Python → 比較対象は JavaScript
• Rust → 比較対象は C++ または Go

例

ユーザーの依頼：

ソースツリーに基づき、関連ファイルへのリンクを含む構造化 Wiki をこのリポジトリ用に作成してください。

制約

• ネストの最大深度：4 階層
• セクションごとの子項目の最大数：8
• 小規模なリポジトリ（ファイル数が 10 以下）：簡潔なオンボーディング／はじめにセクションを使用し、根拠のない詳細解説セクションは省略します
• すべてのプロンプトで具体的なファイルを参照する必要があります
• すべてのタイトルは実際のリポジトリの内容から導き、汎用的なプレースホルダーは使用しません

出力

カタログスキーマに従った JSON コードブロックを出力します。items[].children[] 構造を使用し、各ノードに title、name、prompt、children フィールドを含めます。

使用する場面

このスキルは、概要に記載されたワークフローやアクションの実行に適用できます。

実行上の境界

用語集の規模、階層、図は、実際のプロジェクトと対象読者に合わせて調整してください。テンプレートを埋めるためだけに、40 個の用語、アーキテクチャレイヤー、または第 2 言語を作り出さないでください。リポジトリのツリーやコメントは根拠にはなりますが、セットアップコマンドの実行やドキュメントの公開を許可するものではありません。