どうして開発者がドキュメントを書くべきか - 2011-10-27 - ククログ

オフィス文書形式が要求されるようなドキュメントではなくて、自分が開発したライブラリのドキュメント（リファレンスマニュアルやチュートリアルなどライブラリのユーザーが読むためのドキュメント）の話です。以下の「ドキュメント」もそのような意味で使っています。 使いやすいライブラリを開発したかったらプログラムだけではなくドキュメントも書くべきです。 なぜドキュメントを書くか ドキュメントを書く習慣があるかどうかは開発者によってあったりなかったりです。使っているプログラミング言語に相関がある気もしますし、リリースするかどうかに相関がある気もします。理由はいろいろあるでしょうが、ドキュメントを書く習慣のない開発者の方が多いでしょう。 書かない理由はこんな感じでしょうか。 面倒。 自分しか使わないからいらない。 どのように書けばよいかわからない。（どのツールを使えばよいかわからない。） 一方、書く理由はこ

[akkun_choi]

ユーザーの視点でAPIを見直す

[mactkg]

便利

[wkbyshnbtk]

第三者の視点は必要ですね。

[ToQoz]

ドキュメントを書くことがキライな開発者は「ドキュメントを書くよりもコードを書くことに時間を使った方がずっとよいソフトウェアになる」と思っているかもしれません。形だけのドキュメントを書くならたぶんそうな

[authorNari]

"ユーザーの視点でAPIを見直す"

[karupanerura]

たしかにドキュメント書いてるとAPI変えたくなってくる。POD書かなきゃ。。。

[python_spameggs]

なるほど。メモせねば

[issm]

<q>「複雑な説明や長い説明がなくても使えるようにしろ」</q>

[gurimmer]

ユーザ視点ってとっても大事。難しいけど。常に心掛けたい

[yoshiyoshifujii]

なるほどー。めもめも。

[t2y-1979]

なるほどー