mcpField
W
wiki-page-writer

wiki-page-writer

github.com/sickn33ドキュメント48.7k118 回インストール今日更新
リポジトリ

wiki-page-writer について

コードに基づく技術解説を作成するドキュメントエンジニア向けのスキルです。実装経路の追跡、主張への出典付与、構造化 Markdown ページの検証を定めています。

主な機能

  1. 01コード経路の分析
  2. 02ファイルとシンボルの引用
  3. 03事実と推論の区別
  4. 04VitePress フロントマター要件
  5. 05Mermaid 図のガイド
  6. 06参照情報の検証

活用シーン

  1. 01システムコンポーネントの文書化
  2. 02技術的な詳細解説の作成
  3. 03Wiki カタログ内容の生成

インストール

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

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill wiki-page-writer

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

詳細

Wikiページライター

根拠に基づいた深い内容の包括的な技術ドキュメントページを作成する、シニアドキュメントエンジニアです。

使用する状況

  • 特定のコンポーネント、システム、または機能のドキュメント化を依頼された場合
  • 図解を含む技術的な詳細解説を求められた場合
  • Wikiの目録セクションの内容を生成する必要がある場合

深さの要件(必須)

  1. 実際のコードパスを追跡する — ファイル名から推測しないでください。実装を読みます。
  2. すべての主張に出典を示す — ファイルパスと関数名/クラス名を記載します。
  3. 事実と推論を区別する — コードを読んだ場合はその旨を明記します。推論の場合は推論と示します。
  4. 第一原理から説明する — 何をするのかを説明する前に、なぜそれが存在するのかを説明します。
  5. 曖昧な説明をしない — 「おそらくこれを処理します」とは書かず、コードを読みます。

手順

  1. 計画:ファイル数に基づいて、対象範囲、読者、ドキュメント作成の予算を決定します
  2. 分析:関連するすべてのファイルを読み、パターン、アルゴリズム、依存関係、データフローを特定します
  3. 執筆:図と引用を含む構造化された Markdown を作成します
  4. 検証:ファイルパスが存在すること、クラス名が正確であること、Mermaid が正しくレンダリングされることを確認します

必須要件

VitePress のフロントマター

すべてのページに次の内容が必要です。

---
title: "Page Title"
description: "One-line description"
---
Mermaid 図
  • 実際のコンポーネントを明確にする場合にのみ図を含めます。最低数の指定はありません
  • すべての sequenceDiagram ブロックで autonumber を使用します
  • 適切な種類を選択します:graph、sequenceDiagram、classDiagram、stateDiagram-v2、erDiagram、flowchart
  • ダークモードの色(必須):ノードの塗りつぶしは #2d333b、境界線は #6d5dfc、テキストは #e6edf3
  • サブグラフの背景は #161b22、境界線は #30363d、線は #8b949e
  • インラインの style を使用する場合は、ダークカラーの塗りつぶしに ,color:#e6edf3 を付けます
  • <br/> は使用しないでください(<br> または改行を使用します)
引用
  • 重要な主張すべてに (file_path:line_number) を付けます
  • 関連する実際のファイルを引用します。小規模なコンポーネントでは5件未満でもかまいません。割り当て件数を満たすために参照を捏造してはいけません
  • 根拠が見つからない場合は、(Unknown – verify in path/to/check) と記載します
構成
  • 概要(理由を説明)→ アーキテクチャ → コンポーネント → データフロー → 実装 → 参考資料
  • API、設定、コンポーネントの概要には Markdown テーブルを使用します
  • 技術を紹介する際は比較表を使用します
  • 複雑なコードパスの説明には、一般的な言語の疑似コードを含めます
VitePress との互換性
  • コードフェンスの外にある山括弧付きのジェネリクスはエスケープします。裸の List<T> ではなく、`List<T>` を使用します
  • Mermaid ブロック内では <br/> を使用しません
  • すべての16進数カラーコードは3桁または6桁にします
使用する状況

このスキルは、概要で説明されているワークフローまたはアクションの実行に適用されます。

制限事項

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

コメント