アカウント名:
パスワード:
できあがったものの簡潔な説明は、確かにここで指摘されたように有用だと思う。けど、設計書にその役割を求めると、理想はともかくとして大概「格言」に引っ掛かることになるよね。
出来上がったもののを書くのは順番が逆です。ほぼ意味が無い。ドキュメントとして必要な部分を理解していれば、メンテナンスも困難ではありません。
問題になるとすれば ・必要以上のものを「必須記述項目」として管理しようとしている ・プロジェクト面メンバーの怠惰（後の事、他人のことを考慮しないモラルの低さ）ぐらいしかなく、それは必ずクリアする必要があるものです。
# 個人や超少人数なら、ほとんどドキュメントは不要かも・・・
設計書は設計書であり、例えばメンテとかに使うには「必要以上」のものが入らざるを得ないと思うんだけど。
コードのメンテナンスに限定するのなら、別に作ったドキュメントはあまり役に立ちませんよ。結局、そのドキュメントに書かれていることが正しいかどうかの確認のため、ソース解析を行うことになりますし。そんなものに工数をかけるなら、ソースコード上のコメントを増やしてもらった方が解析がはかどります。
システム全体のメンテナンスを行うのならそれは設計の範疇ですから、コードからおこしたドキュメントを使うなんてナンセンスですし。
そのコメントが正しいという保証は？
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
一つのことを行い、またそれをうまくやるプログラムを書け -- Malcolm Douglas McIlroy
前か後か (スコア:1)
できあがったものの簡潔な説明は、確かにここで指摘されたように有用だと思う。
けど、設計書にその役割を求めると、理想はともかくとして大概「格言」に引っ掛かることになるよね。
Re: (スコア:0)
出来上がったもののを書くのは順番が逆です。ほぼ意味が無い。
ドキュメントとして必要な部分を理解していれば、メンテナンスも困難ではありません。
問題になるとすれば
・必要以上のものを「必須記述項目」として管理しようとしている
・プロジェクト面メンバーの怠惰（後の事、他人のことを考慮しないモラルの低さ）
ぐらいしかなく、それは必ずクリアする必要があるものです。
# 個人や超少人数なら、ほとんどドキュメントは不要かも・・・
Re:前か後か (スコア:0)
設計書は設計書であり、例えばメンテとかに使うには「必要以上」のものが入らざるを得ないと思うんだけど。
Re: (スコア:0)
コードのメンテナンスに限定するのなら、別に作ったドキュメントはあまり役に立ちませんよ。
結局、そのドキュメントに書かれていることが正しいかどうかの確認のため、ソース解析を行うことになりますし。
そんなものに工数をかけるなら、ソースコード上のコメントを増やしてもらった方が解析がはかどります。
システム全体のメンテナンスを行うのならそれは設計の範疇ですから、コードからおこしたドキュメントを使うなんてナンセンスですし。
Re: (スコア:0)
そのコメントが正しいという保証は？
Re: (スコア:0)
それが正しいという保証なのか、間違ってるという保証なのかが人間には判然としないというだけで