READMEも「初めて見る人向け」に書き直させ、デザインスキル(Impeccable)で整える
エージェントに更新を任せていると、READMEは少しずつ変更履歴の寄せ集めになる。構成を指定して書き直させ、仕上げにUI用のデザインスキルを文章にもかける。
どんな問題を解決するか / いつ使うか
Claude Code / Codex が機能追加のたびにREADMEへ追記した結果、冒頭で「何のツールか」が分からなくなったとき。READMEはリポジトリの最初の画面なので、見た目と同じく情報の並びが大事。
やり方
- 次のように頼む(意訳)。
- 初めてこのプロジェクトを見る人向けに README.md を書き直す
- 最初の1文で「何か・誰のためか」を言う
- できることを短い箇条書きで並べる
- 最後にインストール手順。必要な環境は表にする
- バージョン履歴はすべて CHANGELOG.md に移す
- 仕上げにデザインスキルをかける。投稿者の例では
npx impeccable installのあと、/impeccable clarify README.md(分かりにくい所を直す)と/impeccable distill README.md(削って要点だけにする)を実行。
注意点
- Impeccable は本来UI向けのスキル。文章に使うのは投稿者の工夫で、結果は必ず読んで確認する。
- 「変更履歴はCHANGELOGへ」とAGENTS.mdにも書いておくと、また寄せ集めに戻るのを防げる。
関連
出典
- @Voxyz_ai post