skill-guided-doc-writing は何をしますか？
スキャンしやすく、具体的で説得力のある文書を作成するためのエージェントスキル
概要
このスキルは、AIエージェントが開発者向けの文書を作成する際に、以下の3つの原則に従って文章を構成します。
- スキャン可能: 見出し、箇条書き、強調を適切に使う
- 具体的: 曖昧な表現を避け、データや事例で裏付ける
- 説得力がある: 主張の根拠を示し、読み手の行動を促す
使い方
エージェントに以下のように指示してください。
この仕様書をスキャンしやすく、具体的で説得力のある形式に書き直してください。
サポートされるプラットフォーム
- Claude Code
- Cursor
- Codex
- その他、マークダウンをサポートするAIエージェント
原則の詳細
スキャン可能
- 適切な見出し（
#,##,###）を使う - 1段落は3〜4文以内に抑える
- 重要な箇所は太字または
コードで強調する - リストは
-または1.で整理する
具体的
- 「良い」→「パフォーマンスが20%向上した」
- 「すぐに」→「3営業日以内に」
- 必要に応じてテーブルやコード例を挿入する
説得力がある
- 主張には理由またはデータを添える
- 比較表を示して優位性を明確にする
- 結論部分で読み手に次のアクションを促す
例
改善前
このライブラリは高速で、使いやすいです。多くの開発者が推奨しています。
改善後
このライブラリを選ぶ3つの理由
- パフォーマンス: 従来比で30%高速な処理を実現 (ベンチマーク:
npm run bench) - 使いやすさ: 3行のコードで導入完了。詳細はクイックスタートを参照
- コミュニティ: GitHubスター2000以上、毎週10件のコントリビューションあり
次のプロジェクトでは、ぜひこのライブラリをお試しください。
ライセンス
MIT