テック技報最新号へ →
AIコーディング

エージェントが書いた長い PR 説明は <details> に畳み、先頭に人が選んだ数行だけを出す

PR の冒頭には「人が読むべき最短の説明」(と必要ならスクリーンショット)だけを置き、エージェントが書いた詳しい説明は <details><summary>モデル名</summary> … </details> に畳む。

@simonw · 投稿 2026-11-09
#ai-coding#pull-request#github#レビュー#ドキュメント

どんな時に使う?

  • Claude Code や Codex に PR を作らせると、正確だが長すぎて誰も読まない説明になる
  • 読み手に「この PR に時間を割く価値があるか」をすぐ判断してほしい
  • AI が書いた部分と人が判断した部分を見分けられるようにしたい

手順

  1. 冒頭の1段落を「人の判断」として書く。エージェントの文から使える一文を拾ってもよい(例: 何が困っていて、どう変わったか)
  2. 画面の変更なら、ここにスクリーンショットを1枚
  3. その下に、エージェントの説明全文を畳む:
    html
    <details>
      <summary>Claude Opus 5.5 Medium</summary>
    
    (エージェントが書いた説明全文)
    </details>
  4. summary にはモデル名(と effort)を書き、「ここから下は AI の文」だと分かるようにする

書かせ方の例

注意点

  • <details> は GitHub の Markdown でそのまま使える(Issue コメントでも可)。<summary> を <details> の内側に置く順番を間違えない(Simon Willison は「details-summary」と口に出して覚えるとよいと書いている)
  • <details> の中で Markdown を効かせるには、</summary> の後に空行を入れる(GitHub の一般的な挙動)
  • 「冒頭の短い説明は自分の判断」という約束を守ることが前提。冒頭まで AI の文をそのまま貼ると意味がない

出典

X の元の投稿を開く