ドキュメントをいい具合に残そうの会 - Qiita

最近、『エンジニアのためのドキュメントライティング』という本を読みました。 非常にためになる内容だったので、本書であがったいくつかのポイントを私なりにまとめてみました。 また、エンジニアにとってのドキュメントは種類が多く、それぞれのニーズとそれに合わせたフォーマットも違うため、 良いドキュメントとは何か？ を一概に述べることは難しいです。 個人的には、「ほぼ知識のない人が読んでも再現できる・解決できる」ということが大事なのではないかと思っています。 そこで、本記事ではドキュメントの範囲を少し絞って、想定される読者をエンジニア寄りに考えて書いています。ご了承ください。 目次 本記事では ドキュメントを作成する前 ドキュメントを作成する時 ドキュメントを作成した後 それぞれのタイミングにおけるポイントを挙げていきます。 📑 ドキュメント作成前のポイント フリクションログとは、あるユーザー1の

[yarumato]

“書籍『エンジニアのためのドキュメントライティング』　ユーザーの体験を、期待する振る舞いと実際との衝突（friction）として記録。ユーザーは流し読みするため、内容が一目で分かる見出しをつけておく”

[xlc]

もうコピペプログラマの「やってみた」にはウンザリなんだよ。