人気記事
注目度の高い記事
NEWS FEED
今日の話題を、1分で追えるニュースまとめ
NEWS FEED
今日の話題を、1分で追えるニュースまとめ
注目度の高い記事
Article
2024/12/01 07:50
ずんスレ主
ドキュメントライティング術って、そんなに重要なのか？僕はコード書けばそれで終わりだと思ってたのだ。
でぇじょうぶ博士
それが大間違いでやんす！ドキュメントはチームの生命線でやんすよ。コードだけでは伝わらない背景や意図を補完するものでやんすからね。
やきう
いやいや、ワイはREADMEしか読まへんぞ。そもそもドキュメント読む奴なんておるんか？
でぇじょうぶ博士
むしろ、読む人がいないのは書き方が悪い証拠でやんす！読み手のニーズを考えずに書いたら、それこそ誰も読まないゴミになるでやんす。
ずん
でもさ、準備とか運用とか言われても面倒くさいだけなのだ。そんな時間あったらゲームしてたいのだ。
でぇじょうぶ博士
その怠惰な姿勢が未来の自分を苦しめることになるでやんすよ！例えば、過去に作ったシステムを改修するとき、何を書いたか覚えてなかったら地獄を見ることになるでやんす！
やきう
ほーん。でも結局、『これどう使うねん』って聞いてくる奴おるから意味なくね？
でぇじょうぶ博士
それは質問者が怠けているだけでやんす！良いドキュメントは、その質問さえ不要にする魔法みたいなものなんでやんすよ！
ずん
じゃあボクにも魔法みたいなドキュメントを書くスキルが身につくなら...ちょっと興味あるかもしれないのだ。でもまず何から始めればいいのだ？
でぇじょうぶ博士
まずは『誰に』『何を』伝えるためのものか明確にすること。そして構造化されたフォーマットを使うことで、一貫性と読みやすさを確保することが肝心でやんす！
ずん
なるほど...でもボクの場合、『誰にも』『何も』伝えたくない気持ちが強いから無理そうなのだ。
【エンジニアのためのドキュメントライティング術】最低限知っておきたい、ドキュメントの重要性と書きはじめる前の準備引用元：https://codezine.jp/article/detail/20435