HeadlinesBriefing HeadlinesBriefing.com

実際のユーザーでREADMEテスト ドキュメント改善

Hacker News •
×

開発者はしばしばユーザーが自分のバイアスや知識を共有していると仮定し、質の低いドキュメントを書く。これを克服するため、著者は実際のユーザーに時給25ユーロを支払い、Activity BotのREADMEを指示に従って声に出しながら画面を共有してテストさせた。これにより重大な欠陥が明らかになった:デモリンクが切れている、ファイル名の変更手順がわかりにくい、技術用語が不明確、セクションの順序が悪い、ソフトウェアの目的が説明されていない。著者は手書きのメモを取り、各セッション後にREADMEを更新し、新しいユーザーで再テストを行った。複数のセッションを通じて、率直なフィードバックに対して合計150ユーロを支払った。このプロセスは、実際のユーザーが開発者が見落としがちな前提条件―sudoの必要性、再起動の要件、引用ルール―を暴露することを示した。LLMsとは異なり、実際の人間はユーモア、独自の視点、イライラなどの感情的手がかりをもたらし、これがドキュメントがどこで失敗しているかを示す。著者はこれを自分のGOV.UKでの技術文書作成経験と比較し、そこで人間のレビューが花言葉のような散文を明確で使いやすいドキュメントに変えたことを指摘した。READMEはまだ完璧ではないが、今でははっきりと従いやすくなった。核心的な教訓:開発者はドキュメントを実際に声に出して考える人々(無報酬でも)でテストすべきであり、それによって盲点を発見し、使いやすさを向上させることができる。

出典: Hacker News · 要約:HeadlinesBriefing