0
2
テーマ、知りたいこと
仕様書って必要ですか？
背景、状況
装置設計が出来るけどソースコードを読めない上司が「ソフトウェアの仕様書を書いて」とうるさいです。
仕様書なんか書かなくても箇条書きのメモがあれば直接ソースコードを書けるし、ソースコードを読めば制御コードもあるし、まとまった機能ごとにクラス分けしているし、関数を呼んでいるタイミングや順番も全部わかるし、コメントも満載だから、後々誰かに引き継ぐとしても、ソフトウェアエンジニアなら、下手な文章でダラダラ書いた仕様書を読ませるより「ソースコード見て」「動かしてみて」と言った方が理解は早いと思うのです。
回答4件
#1
総合スコア11078
投稿2023/09/16 03:32
装置設計が出来るけどソースコードを読めない上司が「ソフトウェアの仕様書を書いて」とうるさいです。
一般的には仕様書は必要と思いますが、質問者さんが「うるさい」と思うのは「仕様書を作成する」作業が質問者さんの業務の範囲を超えるからでしょうか？そうでなければ業務指示としてやらなければならないかと思います。
仕様書なんか書かなくても箇条書きのメモがあれば
メモをそのまま資料としても良いのではないでしょうか？（そのメモの品質によるかもしれませんが）
コメントも満載だから
AIを利用してソースコードから仕様書を作成してはどうでしょうか？またはコメント満載であればコメントを抜き出すだけでも良いかもしれませんね。
ソフトウェアエンジニアなら、下手な文章でダラダラ書いた仕様書を読ませるより「ソースコード見て」「動かしてみて」と言った方が理解は早いと思うのです。
確かに「下手な文章」は読みにくいので第三者が見て分かるように書かなければなりませんね。「ソースコード見て」というのはソースコードが短くて完璧であればまだ良いかもしれませんが、バグがあったら致命的ではないでしょうか？「動かしてみて」というのも同じで設計通りにコードが作成されているかどうやって第三者が確認できるのでしょうか？
#2
またはコメント満載であればコメントを抜き出すだけでも良いかもしれませんね。
それが良いかも知れませんね。
#3
総合スコア38350
投稿2023/09/16 06:47
広い意味での仕様書は必要です。
この意味での仕様書は、そのシステムはどういうものか、どうあるべきかを書いたものです。
いっぽうソースコードおよび成果物はそれを具現化したものです。
どちらかに相違があった場合、仕様書が正となります。つまりバグです。
そのシステムの品質、なにが正しいか？を判断、担保する根拠として仕様書が必要になってきます。
ただ実際のところ、数百行程度までのスクリプト言語コードであれば、コード先頭に簡単な使い方含めメモ書き程度の仕様書も含めることもあります。
#4
総合スコア12342
投稿2023/09/21 07:34
背景がよくわかりませんが，
まずは要求している側に｛何故必要なのか（目的），具体的にどんな情報があればよいのか，etc｝を問うてみればよいのでは．
そうすれば「用意すべきミニマムな物」がわかるでしょうから，それを作れば良いのでは（というか，上から作れと言われたら作るしかない気がする）．