Communityライティング&編集github.com

liang-senbei/curating-readme

リポジトリの実際の情報を監査し、README や関連ドキュメントを標準化された構造に更新するスキル。リポジトリに基づいており、決して捏造しません。

curating-readme とは?

このスキルは、Claude Code などの AI エージェントがリポジトリを徹底的に監査し、その実際の内容を反映した README や関連ドキュメントを標準化された構造で生成・更新できるようにします。主な目的は、リポジトリのソースコード、依存関係、構成ファイル、プロジェクト構造などの実情報に基づいてドキュメントを再構成し、誤った情報や古い情報を含まないようにすることです。スキルは、リポジトリ内のファイルを直接解析し、プロジェクトの目的、インストール手順、使用方法、API リファレンス、テスト、コントリビューションガイドなどのセクションを標準テンプレートに従って編成します。これにより、AI エージェントが生成したドキュメントの一貫性、正確性、信頼性が向上し、開発者が手動でドキュメントを保守する手間を大幅に削減します。対応プラットフォームは主に Claude Code ですが、他の AI エージェントツールにも応用可能です。

対応✓Claude Code~Codex CLI~Cursor
npx skills add liang-senbei/curating-readme

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

curating-readme は何をしますか?

Claude Agent Skill: リポジトリの実際の情報を監査し、README や関連ドキュメントを標準化された構造に更新します。リポジトリに基づいており、決して捏造しません。

概要

このスキルは、AI エージェント(例: Claude Code)がリポジトリのソースコード、依存関係、構成、プロジェクト構造を解析し、以下のことを行います:

  • リポジトリの実際の目的と機能を特定する
  • インストール、使用方法、API リファレンス、テスト、コントリビューションなどの標準セクションで README を生成または更新する
  • ドキュメント内の情報がコードベースと常に一致することを確認する
  • 誤った前提や架空の詳細を避ける

使用方法

このスキルは、リポジトリのルートディレクトリで AI エージェントに次のように指示することで有効になります:

このリポジトリの README を監査し、標準化された構造に更新してください。

サポートされる機能

  • 監査: リポジトリ内のファイルをスキャンし、実際のプロジェクト情報(言語、フレームワーク、依存関係、スクリプトなど)を抽出します。
  • 標準化: 事前定義されたテンプレートに従って、README セクションを整理します。
  • 整合性チェック: 生成されたドキュメントをリポジトリの実際の内容と照合し、正確性を検証します。
  • 更新: 既存のドキュメントを上書きするか、新しい README ファイルを作成します。

注意事項

  • このスキルは、リポジトリの実際のファイルにのみ依存します。外部 API や想定される動作に依存しません。
  • 複数のファイルタイプ(Markdown、YAML、JSON、ソースコードなど)をサポートします。
  • リポジトリのルートディレクトリに書き込み権限が必要です。

例

README.md がないリポジトリの場合:

# リポジトリ名

## 説明

このリポジトリは... [プロジェクトの目的]

## インストール

```bash
npm install

使用方法

npm start

関連スキル