mcpField
W
whitepaper-audit

whitepaper-audit

github.com/glebisドキュメント40152 回インストール1 日前に更新
リポジトリ

whitepaper-audit について

Markdown のホワイトペーパーを決定的なチェックと独立した LLM レビューで監査し、指摘を優先度付きレポートにまとめるスキルです。文書へのフィードバックを求める執筆者向けで、明示的な依頼がある場合のみ文書を修正します。

主な機能

  1. 01決定的な文書チェック
  2. 02独立した LLM レビュー
  3. 03指摘の重複排除と優先順位付け
  4. 04提案モードと明示依頼による修正モード
  5. 05レビュープロンプトの評価ケース

活用シーン

  1. 01共有前の Markdown ホワイトペーパー確認
  2. 02可読性とリンク切れの確認
  3. 03文書修正に向けた問題の優先順位付け

インストール

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

$npx skills add https://github.com/glebis/claude-skills --skill whitepaper-audit

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

DESIGN.md
evals/
README.md
RESULTS.md
evals/cases/
clean-control.md
missing-limitations.md
planted-defects.md
evals/stripped/
clean-control.md
missing-limitations.md
planted-defects.md
references/
audit-prompt.md
checklist.md
scripts/
check_doc.py
scripts/tests/
test_check_doc.py

詳細

whitepaper-audit

Markdown のホワイトペーパーを 2 つのレーンで監査し、優先順位付きの統合レポートを作成します。

入力

  • ドキュメントのパス(必須)— Markdown ソース。PDF は対象外です。
  • 想定読者(指定がなければ確認してください)— audience-fit/jargon-undefined の重大度は、想定読者によって異なります。デフォルトは「技術実務者、非アカデミック」です。
  • モード — recommend(デフォルト)または fix(明示的に依頼された場合のみ)。

ワークフロー

1. レーン 1 — 決定論的チェック
python3 scripts/check_doc.py <doc.md> --offline [--target-grade N] [--allow ACRO]

--offline を外すと、HTTP(S) リンクもチェックします(HEAD→GET、タイムアウトあり。検出対象は 壊れた リンクのみ)。出力は JSON の指摘事項です。スキーマは DESIGN.md を参照してください。

2. レーン 2 — LLM による判定

references/audit-prompt.md を使い、{PATH} と {AUDIENCE} を埋め、references/checklist.md の [judge] 基準を加えて、新しいコンテキストの サブエージェント に処理を依頼します(同じコンテキストで自分が書いたドキュメントを判定してはいけません)。判定役は JSON の指摘事項を返します。

判定の調整ルールは必ず守ってください。引用は原文どおりに必須とし、確信度が低い場合に P0 を付けず、「事実誤認」ではなく「検証が必要」とします。

3. 統合

(場所、問題の種類)で重複を排除し、両方のレーンでの帰属を保持します。P0 → P1 → P2 の順に並べ、次に確信度で並べます。相互参照:主張を裏付けるレーン 1 の壊れたリンクは P1 とします(重要性は判定役が判断)。装飾的なリンクは P2 とします。

4. レポート(デフォルトモード)

Markdown レポートを作成します。内容は、総合評価、指摘事項の表(ID、重大度、確信度、場所、修正案)、詳細の順です。修正を提案しますが、編集は行いません。

5. 修正モード(明示的に依頼された場合のみ)

P0 を最優先に修正します。コードを変更する場合は、superpowers のテスト駆動開発を通してください(まずテストを書き、失敗することを確認します)。文章を修正した場合は、その後 監査全体を再実行 し、解消された指摘事項と残っている指摘事項を報告します。

評価

新規または変更した判定プロンプトを信頼する前に、evals/README.md の手順を実行してください(意図的に埋め込んだ欠陥と、問題のない対照データを使用します。合格基準は同ファイル内に記載されています)。レーン 1 は scripts/tests/test_check_doc.py(pytest)でテストします。

ファイル

  • scripts/check_doc.py — レーン 1(標準ライブラリのみ。フラグは --help を参照)
  • references/checklist.md — 両レーンの運用基準
  • references/audit-prompt.md — 判定プロンプトのテンプレート
  • evals/ — 判定の検証ケースと合格基準
  • DESIGN.md — アーキテクチャ上の決定事項(v0.2、Codex による監査済み)

コメント