他人は5分しか見ない — READMEと技術選定
動くものは完成しました。でも、リポジトリのURLだけを渡された人には、それが何なのかも、触れる場所も、なぜその技術なのかも伝わりません。この記事では hitokoto のREADMEを「1行でなにか / スクリーンショット / 触れる場所 / 使い方 / 技術構成 / 設計判断 / 既知の問題 / これから」の順で全文書きます。山場は技術選定の1行説明と、できていないことを正直に書くところ。動く場所が無いときの代替(GIF)、デモ用アカウントの作り方、本物の鍵を置かないこと、コミット履歴も見られていること、AIを使ったことを隠さずに書く方法、ライセンスを付けないと「使えない」の意味になること、そして9段階を振り返って次に何をするかまで。就職の指南記事ではありません。他人が5分で理解できる形にする話です。