wiki-onboarding

Wiki オンボーディングガイドジェネレーター

新規参加者からプリンシパルまで、あらゆるエンジニアがコードベースを完全に理解できるよう、相互に補完する2つのオンボーディングドキュメントを生成します。

使用するタイミング

• ユーザーがオンボーディングドキュメントや入門ガイドを求めている
• ユーザーが /deep-wiki:onboard コマンドを実行した
• ユーザーが新しいチームメンバーのコードベース理解を支援したい

言語の検出

リポジトリ内のビルドファイルを確認し、コード例に使用する主要言語を特定します。

• package.json / tsconfig.json → TypeScript/JavaScript
• *.csproj / *.sln → C# / .NET
• Cargo.toml → Rust
• pyproject.toml / setup.py / requirements.txt → Python
• go.mod → Go
• pom.xml / build.gradle → Java

ガイド1：プリンシパルレベルのオンボーディング

対象読者：意思決定の「理由」を知る必要があるシニア／スタッフ以上のエンジニア。

必須セクション

1. システムの理念と設計原則 — システムが維持する不変条件は何ですか？ 重要な設計上の選択とその理由は何ですか？
2. アーキテクチャの概要 — Mermaid 図を用いたコンポーネントマップ。各要素の責務と通信パターン。
3. 主要な抽象化とインターフェース — システム全体が依存する基盤となる抽象化
4. 意思決定ログ — 主要なアーキテクチャ上の決定、その背景、検討した代替案、トレードオフ
5. 依存関係を選んだ理由 — 主要な依存関係を選択した理由と、置き換えたもの
6. データフローと状態 — システム内のデータの流れ（推測ではなく、実際のコードに基づいて追跡）
7. 障害モードとエラー処理 — 何が壊れるのか、エラーがどう伝播するのか、復旧パターン
8. パフォーマンス特性 — ボトルネック、スケーリングの限界、ホットパス
9. セキュリティモデル — 認証、認可、信頼境界、データの機密性
10. テスト戦略 — テスト対象、対象外のもの、テストの理念
11. 運用上の考慮事項 — デプロイ、監視、フィーチャーフラグ、設定
12. 既知の技術的負債 — 近道をした箇所とそのリスクについての率直な評価

ルール

• すべての主張に (file_path:line_number) 形式の引用を付けます。
• Mermaid 図を最低3つ含めます（アーキテクチャ、データフロー、依存関係グラフ）。
• すべての Mermaid 図でダークモードの色を使用します（wiki-vitepress スキルを参照）。
• コミット履歴、ADR、または所有者の根拠が理由を裏付ける場合に限り、「理由」に焦点を当てます。推測した理由や不明なパフォーマンス／セキュリティ特性は明示してください。ソースの構造だけでは意図や測定済みの限界を確定できません。

ガイド2：ゼロから一人前になるためのコントリビューターガイド

対象読者：手順に沿った実践的なガイダンスを必要とする新規コントリビューター。

必須セクション

1. このプロジェクトでできること — 2～3文で説明するエレベーターピッチ
2. 前提条件 — 必要なツール、バージョン、アカウント
3. 環境のセットアップ — 各手順の正確なコマンドと、実行後に期待される出力
4. プロジェクト構成 — どこに何があり、その理由も示したディレクトリツリー
5. 最初のタスク — 簡単な機能を追加するまでの一連の手順
6. 開発ワークフロー — ブランチ戦略、コミット規約、PR プロセス
7. テストの実行 — テストの実行方法、テストすべき内容、テストの追加方法
8. デバッグガイド — よくある問題と診断方法
9. 主要な概念 — ドメイン固有の用語をコード例とともに解説
10. コードパターン — 「X を追加する場合は、このパターンに従う」というテンプレート
11. よくある落とし穴 — 新規コントリビューターが陥りがちなミスと、その回避方法
12. ヘルプの入手先 — コミュニケーションチャネル、ドキュメント、主要な連絡先
13. 用語集 — コードベース内で使われている、意味がわかりにくい用語
14. クイックリファレンスカード — 使用頻度の高いコマンドやパターンのチートシート

ルール

• すべてのコード例で、検出した主要言語を使用します。
• すべてのコマンドをコピーしてそのまま実行できるようにします。
• 確認手順には、期待される出力を含めます。
• ワークフロー図には Mermaid を使用します（ダークモードの色を使用）。
• すべての主張を実際のコードに基づかせ、(file_path:line_number) 形式で引用します。

使用するタイミング

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

例

ユーザーのリクエスト：

新しいエンジニアがこのコードベースを実行し、理解し、安全に変更できるようにするオンボーディングドキュメントを作成してください。

制限事項

• タスクが上記の説明にある範囲に明確に合致する場合にのみ、このスキルを使用してください。
• 出力を、環境固有の検証、テスト、または専門家によるレビューの代わりとして扱わないでください。
• 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、作業を中断して確認してください。