ドキュメント嫌い [プログラミング]
そうそう、いやだなぁドキュメント書くの。
世のプログラマーの名誉のために言っておくが、ただ単にめんどくさいから書きたく
ないと言っているわけではない。
書けと言われているドキュメントのほとんどは＊明らかに読まれない＊
とわかっているから書きたくないのだ。
ソフトウェアは、形がないので納品する時の証拠として、営業の都合で
できるだけ分厚い紙になったドキュメントを用意させられる場合が多々ある。
また、プログラミングのことをよく知らないお客さんは、「できるだけ詳細な」
ドキュメントを欲しがる。プログラマは、「できるだけ詳細な」ドキュメントを
参照すればソースの改変が楽に行えると思っているらしい。
一言でいって「読んでもわからない人ほどドキュメントを欲しがる」ので、
余計、書く気をなくす。
詳細なドキュメントというのは、大抵の場合、
プログラムを読んだほうが早いようなもので、最悪の場合は
プログラムから自動生成したようなもので、とても読めたものではない。
（これは javadoc や pydoc を必要ないと言っているわけではないよ）
テスト結果に○をつけたチェックシートも、受け取る側になってみると
しみじみ「見ないなー」と思う。チェックシートが分厚い方が、よりテストが
ちゃんとなされていると考える宗派もあるようだが、チェックシートの体裁を
整えるほかにもっとやることあるだろうと思ってしまう。
（チェックシートの分厚さを品質の基準にする人たちは、意外とテストツールを
使ってなかったりする）
特に困りものが、ISO 9xxx の認証を受けている会社の場合らしい。
体裁を整えるためのドキュメントが必要部数そろっているかとか、
ヘッダー、フッターが書式にあっているかとか、ページ番号がちゃんと振られているか
とか・・・正直、ドキュメントの中身について考えている暇がない。
（と、いいつつ幸いなことに、私は ISO を厳格に適用しようとしている仕事に
かかわったことがない）
もちろん、あった方が良いドキュメントはある
・なぜにそのプログラムは存在するか
・前提となる条件と改変の場合の制限
・簡単な使い方（設定の仕方）
一般に Why が記述してあるドキュメントは良いドキュメントだ。
どのような処理手順か、とかどのようなデータ構造か、というのはソースや
データーベーススキーマを見ればわかる。
そういえば、UML ってドキュメントとして（そしてツールとして）役に立つの？
役に立つ気もするけど、実際には証拠集めにしかなってない気もするし・・・
誰か使っている人、教えて！
どんなドキュメントがあると良いかを考えるときに、オープンソースについてくる
README やマニュアルでどんなことがおさえてあるかは参考になるなぁと思っている。
だれか、ドキュメントを書かなくても良い仕事をさせてくれないかなぁ。
いい仕事しますよ（必要なドキュメントは書きますし）。
Cialis Et Ulcere <a href=http://cialibuy.com/#>buy cialis canadian</a> Cialis Livraison 24h <a href=http://cialibuy.com/#>buy cialis online canada</a> Levitra Quotazione Farmacia
by JanTrum (2020-04-07 09:12)
Amoxicillin Dosage https://cheapcialisll.com/ - buy generic cialis online safely Levitra De Bayer Precios <a href=https://cheapcialisll.com/#>Cialis</a> Isotretinoin For Sale Internet
by hoacits (2020-06-25 23:50)