mcpField
H
humanize-readme

humanize-readme

github.com/b4r7xドキュメント042 回インストール12 週間前に更新
リポジトリ

humanize-readme について

humanize-readmeは、READMEを点検し、AIらしい表現を具体的で率直な文章に書き換えるスキルです。リポジトリの内容を踏まえて文書を整えたいメンテナー向けです。

主な機能

  1. 01READMEのAIらしい表現を点検
  2. 02プロジェクトファイルで背景を確認
  3. 03率直な文体に書き換え
  4. 04技術的な主張とコードを維持

活用シーン

  1. 01抽象的・誇張的なREADMEの修正
  2. 02実際の内容に沿った文書の更新
  3. 03コマンドやコードブロックの保持

インストール

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

$npx skills add https://github.com/b4r7x/agent-skills --skill humanize-readme

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

同梱ファイルreferences/slop-patterns.md

詳細

READMEを人間らしく書き直す

現在のREADME.mdを読み、AIらしい不自然な表現がないか確認してから、率直で正直な、人間らしい文体に書き直します。

ワークフロー

ステップ1 — READMEを読む

引数で渡されたパスを使用します。指定がない場合は、README.mdを使用します。

cat <readme-path>   # e.g. cat docs/README.md — falls back to cat README.md

また、具体的な内容に書き直せるよう、プロジェクトの実態も確認します。

cat package.json 2>/dev/null | head -20
cat pyproject.toml 2>/dev/null | head -15
ls src/ 2>/dev/null | head -10
ステップ2 — 不自然な表現を確認する

全項目の一覧はreferences/slop-patterns.mdを読んでください。README内で次の表現を確認します。

目立つ不自然な表現のパターン：

  • 使用禁止の流行語：seamlessly、robust、scalable、leverage、cutting-edge、comprehensive、empower、intuitive、powerful、game-changer
  • 2026年ごろに多い曖昧な表現や水増し表現：「it's worth noting」、「let's explore」、「this is designed to」、「makes it easy to」、「enables developers to」、「ensures」、「has been designed」
  • 「In today's...」、「This powerful tool...」、「This repository aims to...」で始まる一般的な書き出し
  • 中身のない形容詞を使った機能一覧：「Blazing fast」、「Enterprise-grade」、「Intuitive API」
  • 正直な不足点がないのに、妙に整いすぎて完全に見える内容
  • プロジェクトについて哲学的に語る締めくくり
  • 文の長さが均一 — すべての文が同じリズムになっている（文の変化を確認）
  • 個人の視点がない — 存在する理由、正直な制限、トレードオフに触れていない
ステップ3 — 書き直す

次のルールに従ってREADMEを書き直します。

文体：

  • コーヒーを飲みながらプロジェクトについて説明するように、率直で具体的に、少しくだけた文体にします
  • 「最新技術」や「業界標準のツール」ではなく、実際の技術名を使います
  • コードブロック、コマンド、リンクはそのまま維持します
  • セクション構成は維持し、文章を書き直します

各セクションについて：

  • プロジェクトの説明／導入 — 何をするものか、なぜ存在するのかを1、2文で説明します。誇張表現は使いません。
  • 機能 — 形容詞を取り除き、具体的な内容を加えます。「高速」ではなく、実際の数値がわかる場合はその数値を示し、わからない場合は機能をそのまま説明します
  • インストール／使い方 — 内容に問題がなければそのまま維持し、「使い始めるにあたって、ようこそ」のような水増し表現を削除します
  • このプロジェクトを選ぶ理由 — 存在する場合、一般論に聞こえる文章は具体的な理由に書き直すか、削除します
  • コントリビューション／締めくくり — 「リポジトリにスターを付けてください」という表現や、哲学的な文章、長すぎる貢献ガイドを削除します

トーンのルール：

  • 不足点を正直に伝えます：「Windowsでは未テストです」、「まだ実験段階です」、「自分の環境では動作します」
  • 短い文と長い文を織り交ぜます。すべてを同じ長さにしません
  • もともと使われていない限り、絵文字は使いません（使われている場合も、使用を減らします）
  • 本当に必要な場合を除き、感嘆符は使いません

禁止事項：

  • 元の内容にない情報を追加しないでください。既存の内容を書き直すだけにします
  • 技術的な正確さを変えないでください。主張は維持し、冗長な表現だけを取り除きます
  • 役に立たないほど簡潔にしないでください。簡潔さより明確さを優先します
  • バッジの行（[![...](...)](#)の形式の行）には触れないでください。CI、バージョン、ライセンスの各バッジはそのまま維持します
ステップ4 — 出力する

書き直したREADME全体を、コピーしてそのまま使えるよう、1つのフェンス付きMarkdownコードブロックで出力します。

コードブロックの前に、変更点を簡潔に記載します（箇条書きは最大2〜3項目）。

禁止表現の全リストと書き換え例： references/slop-patterns.md

コメント

Markdown 対応