AIが使いやすいライブラリの条件
GPUIの設計についてAIに尋ねたことをコピペしました。
1. AI がすでに知っている形に乗る
- 有名な書き方をそのまま借りる
- 名前や考え方を、広く知られたものにそろえます(CSS、SQL、HTTP、pandas、Unix のコマンドなど)。
- 独自の言葉を発明すると、AI は「たぶんこうだろう」と似た別物で書いてしまいます。
- 同じことは同じ名前・同じ順で
getとfetchとloadを混ぜない、引数の順をそろえる、といったことです。- 一部を見れば残りが当てられる作りだと、AI は当てて正解します。
2. 間違いを早く、はっきり返す
- 間違った使い方は、動かす前に止める
- 型やスキーマで「ありえない組み合わせ」を書けなくします。
- Rust の型で崩れた UI がコンパイルを通らないのと同じ理屈です。
- AI は試して直すのは得意なので、止める場所が早いほど強いです。
- エラーの文で直し方まで言う
- 例:「
xは 0〜1 です。100 を渡しましたが、% で渡しましたか?」 - エラーの文は AI にとって一番読まれる説明書です。
- 例:「
- 黙って失敗しない
- 空の結果、黙った丸め、黙った既定値が一番危ないです。
- AI は「動いた」と思い込んで先へ進みます。
3. 迷う余地を減らす
- やり方を 1 つにする
- 同じことに 3 通りの書き方があると、混ぜて書かれて壊れます。
- おすすめの道を太く 1 本にします。
- よい既定値を持たせる
- 何も指定しなくても、まともな結果になるようにします。
- GPUI の色や余白が決まった値の中から選ぶ形なのと同じです。
- 自由な数値より、決まった選択肢から選ばせます。
- 隠れた状態を減らす
- グローバルな設定、呼ぶ順番の決まり、裏で変わる値は、AI には見えません。
- 入力から出力が決まる作りほど、正しく使われます。
4. 部品を小さく、組み合わせで作る
- 大きな万能部品より、小さな部品の組み合わせにする
- 組み合わせ方が分かれば、知らない用途にも広がります。
- 万能部品は設定項目が多く、AI はそこで迷います。
- 部品どうしの取り決めを統一する
- どの部品も同じ形で受け渡しできるようにします(UI ならどれも同じ要素の型を返す、など)。
5. 見本を置く
- 短く、そのまま動く例を、主な使い方ごとに 1 つずつ置く
- AI は説明文より見本を真似ます。
- 古い書き方の例が残っていると、それも真似されるので消します。
- AI 向けの要約を 1 ファイルに用意する
llms.txtのような、全体を短くまとめた文書です。- 長い説明書を読みに行けないときの頼りになります。
- Mt Pelerin の資料が「.md を付ければ素の文書が取れる」作りだったのは、この流れです。
6. 結果を AI が確かめられるようにする
- 結果を文字で見られる形にする
- 状態を表示する関数、差分、ログ、テスト用の仕組みなどです。
- AI は画面を見るのが苦手なので、文字で確かめられると直せます。
- 小さく試せるようにする
- 全体を立ち上げなくても、部品ひとつで動かせるようにします。
Write a comment