2013年1月14日月曜日

仕様書や設計書に

「○○、□□など」の様に「など」と含みを持たせる表現をしてはいけない。
納品後に追加機能を無償でやらなければいけなくなる。
むしろ、その「など」がなんなのかをはっきりさせるのが上流工程の設計である。
これが出来ていないのは仕事をしていないことと同じだ。

作成されているドキュメントが「○○案」だとか「××(仮)」、「△△ネタ」とかとなっていると、WBSがはっきりしていない可能性があり、作業時間は多いのに一向に何も決まらない状況になってしまう。ソフト屋さんに無理をお願いしてお金も払えないことになりかねない。

あと、ドキュメントはですます調を統一したり、主語をはっきり意識しないと、読む人はとっても辛い。
例えば、ボタンクリックしてCSVを出力する機能について、詳細設計書に、
「ボタンクリックされると、CSVファイルが出力されます。」
とか。
プログラムとしては、「出力されるのではなく」、「出力する」が正しい。



0 件のコメント:

コメントを投稿