mcpField
G
good-docs-audit

good-docs-audit

github.com/composiohqドキュメント30.8k117 回インストール今日更新
リポジトリ

good-docs-audit について

`good-docs-writing` のルールに照らして文書を確認し、具体的な逸脱を報告するスキルです。既定では指摘のみを提示し、明示的な依頼がある場合に限ってファイルを編集します。

主な機能

  1. 01執筆ルールを審査基準として使用
  2. 02各指摘にファイル名と行番号を記載
  3. 03問題箇所を引用して書き換え案を提示
  4. 04既定では報告のみで編集しない

活用シーン

  1. 01文書のスタイル逸脱の監査
  2. 02ファイルを編集せず実行可能な指摘を作成
  3. 03明示的な依頼に応じた文書の書き換え

インストール

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

$npx skills add https://github.com/composiohq/composio --skill good-docs-audit

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

同梱ファイルreferences/audit-process.md

詳細

優れたドキュメントの監査

対象のドキュメントを good-docs-writing のルールに照らして確認し、文体から逸脱している箇所を報告します。既定の動作は報告のみです。指摘事項を提示し、編集は行いません。ユーザーが修正、書き直し、または適用を明示的に指示した場合に限り、ファイルを変更します。

手順、優先度順の違反チェックリスト、レポート形式、報告ルールについては、references/audit-process.md を読んでください。

必須事項:

  • 最初に good-docs-writing とその references/style-guide.md を読んでください。これらのルールが評価基準であり、このスキルは手順を定めるものです。
  • 指摘事項ごとに file:line を示し、問題のある正確な文言を引用してください。
  • 「修正を検討してください」ではなく、対象の文体に沿った具体的な書き換えを提示してください。
  • 違反をでっち上げないでください。報告が短くても問題ありません。

コメント