2021-01-01から1ヶ月間の記事一覧

エンジニアのドキュメント(作成資料)は、わかってる前提の記述が多すぎて他の人に内容が伝わらない

というお話。 レビュワーも前提をわかってるので指摘から漏れがち だったり 書いた人もしばらくしてから見直すと、何言ってるかわからなかったり、何の事か理解するのに時間がかかったりしがち ソースコードに書かれてるコメントがこんな状態だと、小一時間…