Eyes, JAPAN Blog > ドキュメント書こうよ!

ドキュメント書こうよ!

hanyu

この記事は1年以上前に書かれたもので、内容が古い可能性がありますのでご注意ください。

皆さんこんばんは。
会津は本格的に寒くなって参りまして、毎朝震えておりますがいかがお過ごしでしょうか。

昨日、岩渕さんが書かれていたことと少々重なりますがドキュメントを書くということの大切さををここ数日非常に感じております。
というのも、先日Readmeを書いていただくために自分の作ったプログラムの使い方等をまとめていたのですが、もともと書いてあった仕様とだいぶ異なってきてしまっている点が幾つかありましてなかなか難儀しました。
プログラムを書いている間は自分で書いたところなのだから忘れるはずがないと思うのですが、なかなかどうしてしばらく経つとそうはいかないようです。
自分で書いたところがわからないのですから他人が手を加えることを考えてドキュメントを書いてまとめておく、というのは非常に重要なことなのではないかなと思いました。

担当:羽生(おうちの鍵が見つかりません)

Comments are closed.