良いドキュメント・マニュアル・仕様書を書くスレat TECH
良いドキュメント・マニュアル・仕様書を書くスレ - 暇つぶし2ch1:デフォルトの名無しさん
03/10/05 23:34
おまえら、自分で作ったプログラムについての、わかりやすく的確な
ドキュメントを書ける自信はあるか?
仕事で納品したり、他人に見せるプログラムとして公開するつもりなら、
マニュアルや、仕様書などのドキュメントを書く機会は必ずある。

プログラムとドキュメントはとても関係が深い。ドキュメントが整っていない
プログラムなど、ゴミと同じ。それに、ただ書けばいいって物でもない。
ドキュメントがゴミ程の役にも立たなければ、結局それはゴミなのだ。
だらだらと書いた意味不明な文章を他人に見られるのも恥ずかしいよな?

いわばドキュメントを書く技術はプログラマの必須スキルの1つなのだが、
実際は、下手糞なドキュメントが蔓延っている。(これはGNU製に多い)
読んでも無駄とか、書いても無駄とか思ってる奴、その考えを改めろ。
プログラムに対するドキュメントを、ちゃんとした1作品として、
後世に残せるよう努力すべきだろう。

今一度問う。
おまえら、わかりやすく的確なドキュメントを書ける自信はあるか?



レスを読む
最新レス表示
レスジャンプ
類似スレ一覧
スレッドの検索
話題のニュース
おまかせリスト
オプション
しおりを挟む
スレッドに書込
スレッドの一覧
暇つぶし2ch