現在プログラマをしているのですが、
私の会社は自社ソフトウェアを扱う小さな会社という事もあり、
会社では仕様書を一切書かず、わからないことがあれば各担当した
プログラマに聞きにいく、といった感じになっています。
しかし、今回自分が不便を感じた事もあり、自分が作ったものだけでも
文章でまとめて書いておこうと思うのですが、どのように書いていったら良いものなのか書こうとして躓いてしまいました。
あとから見直してわかりやすいような仕様書・・・この場合出来上がったものをまとめるのですが、書き方を教えていただければと思います。
よろしくお願いいたします。
No.1ベストアンサー
- 回答日時:
元SEです。
メインの流れは簡単な図と文章でおこし、それぞれの処理には識別できる記号をつけます。処理はそれぞれ使用をまとめます。
後はそれらをきちんと整理しておけば、後でわかりやすいのではないでしょうか。詳しい処理がわかりませんので、これ以上の説明は難しいですが、もっとも大切なのは「決めたフォーマットを今後も守ること」です。
今後、誰が見ても理解できるようにしておくことが理想ですから、仕様書の作成日・作成者はもちろん、修正を加えた人も修正日・修正内容を残せるようにもしておくべきかと。
No.4
- 回答日時:
現役SEです。
#2様がおっしゃるように、仕様書にも様々なものがあります。ですので、どのような仕様書をお書きになりたいのかを教えていただけると助かります。
少なくとも、
・誤解のない言葉で表現すること
・注意・制限事項は必ず記述すること
・図によってシステムの流れがわかるようにすること
・定義は必ず残すこと
は必要でしょうか。
私は、フォーマットはある程度決めた方が良いかと思います。
「自分だけわかる仕様書」をつくるならフォーマットがあってもなくても良いとは思いますが、もし「誰でもわかる仕様書」を作ろうとするならば、フォーマットは決めておくべきだと思います。
>わからないことがあれば各担当した
>プログラマに聞きにいく、といった感じになっています
プログラマは、仕様書をもとにプログラムを行うものであると思っています。ですので、プログラマに仕様を聞きにいく、というのは少々違うと思います。まずは、仕様書をしっかりと固める。それに基づいてプログラマに仕様を引き継ぎ製品をつくる、ということが大切ではないでしょうか。
その仕様をしっかりさせるには「仕様書」をきちんと書くことが必要です。
お客様とトラブルが起きる場合、「仕様に対する理解の相違」があります。
仕様書に起こすことで、互いの認識を確認することができます。ですので、ぜひ自分だけでなく社内に仕様書の文化を根付かせていただければと思います。(偉そうなことを申し上げまして申し訳ありません)
うちの会社では、営業からほしいといわれた機能を作るのに適していると思われる各システム社員が具体的に考えて作る(SE兼PG?)ような感じで作っています。言葉足らずで誤解を招きました。なにぶん、小さな会社で、請け負うのではなく自社ソフトすので、全てを自分で行うのです。出来上がって機能が足りなければ、営業から言われてつけたし、リリースするのですが、とりあえず、リリース状態のものを
後々のためにまとめておきたいと思っています。
全体の流れと、詳しい説明をわかりやすく書いて行きたいと思います。
ありがとうございました
No.2
- 回答日時:
#1の人とはちょっと違う意見を。
まず、決まったフォーマットは作らないほうがいいと思います。
変に型にはまってしまい、自分の思った表現に合わないことがあります。
そのため、逆に分かりにくいものが出来上がったりしますので、できるだけ自由に書けるものがいいです。
図は大切です。
言葉では表せないようなことが表現できます。
言葉で説明するのが難しいと思ったら図で描いてみましょう。
フローチャート、UML、ER図、マトリックスなど。
あと、仕様書といってもさまざまです。
基本設計書、詳細設計書、コード設計書などあります。
この場合、コード設計書でしょうか?
それぞれに、設計書の粒度が違いますので分別して下さい。
あと、これは最も重要なことですが、わかり易い言葉で書くということです。
誰が見ても同じような理解ができる言葉で書きます。
例えば、「空の文字列」ということは、例えばnullだったり、スペースが入っててもいいのかなど、読み手によって様々に理解が変わりますので、気をつけて下さい。
この回答への補足
そうですね、コード設計になると思います。
基本的な使い方として、このボタンを押したらどうなって・・・というのは単純なものですぐ動かせばわかるのでいいのですが、
ボタンを押したらどの関数が呼び出され、どのようなライブラリが使われていて、又、関数内の詳細な動きをまとめておき、今後変更がある場合、バグが見つかった場合、私が会社をやめたあとに誰でもすぐに変更ができるようにしたいと思っています。
とにかくわかりやすく、というのがキーなのですね。
今書こうとしたら、ソースのコメント(ほぼ全行に書いてあるのですが)をつらつらと並べているようになってしまいました^^;
図を取り入れてわかりやすくしたいと思います。
ありがとうございました
お探しのQ&Aが見つからない時は、教えて!gooで質問しましょう!
似たような質問が見つかりました
- 労働相談 長文になりますが、わかる方教えてください。 先日、体調が悪く会社を欠勤しました。 会社から病院の領収 2 2022/07/27 23:30
- 労働相談 長文になりますが、わかる方教えてください。 先日、体調が悪く会社を欠勤しました。 会社から病院の領収 2 2022/07/27 23:26
- 面接・履歴書・職務経歴書 皆様のご意見をいただきたいです。 アルバイト応募に提出する履歴書を詐称してしまったため、先方にきちん 3 2023/07/21 13:39
- 不動産業・賃貸業 不動産業の事務職について 3 2022/11/27 01:06
- 引越し・部屋探し 賃貸マンションの明け渡しの際にかかる費用を事前に見積もることはできますか? 現在引越しを考えておりま 4 2023/05/07 01:45
- 会社・職場 7月から建築事務でパートとして働いています。 仕事内容は雑用・日報処理・メールや電話対応、 書類の作 3 2022/09/05 18:05
- 転職 現在転職活動中です。先日会社見学いった会社で面接してみたいと言われました。今まで製造業で今回も製造業 2 2023/04/02 21:44
- 会社・職場 自宅兼事務所の郵便物について 1 2022/07/13 18:35
- 分譲マンション 管理組合役員の辞任と受領書について 1 2022/11/25 12:39
- 中学校 作文のテーマってこれで大丈夫でしょうか 3 2022/07/01 10:15
このQ&Aを見た人はこんなQ&Aも見ています
関連するカテゴリからQ&Aを探す
おすすめ情報
このQ&Aを見た人がよく見るQ&A
デイリーランキングこのカテゴリの人気デイリーQ&Aランキング
-
SDカードを挿入すると「写真など...
-
CDやDVDのフォーマットに...
-
コピーできないプロパティを持っ...
-
HDDからSSDへ換装するときにMBR...
-
プリンタのドライバーをUSB Fla...
-
SSDにフルフォーマットしてはい...
-
LinuxでNTFSファイルシステムの...
-
MOのフォーマット方法
-
全銀フォーマット
-
HDD Scanで不良セクタを検査す...
-
【SDカード】読めるけど書き込...
-
外付けHDDの中身だけ交換
-
DVD-RAMがフォーマット...
-
音の入っているFD開くとフォ...
-
車で使用していた音楽用のSDカ...
-
複数のUSBを同時にクイックフォ...
-
CD-Rがフォーマットできなくて...
-
快活クラブなどのネットカフェ...
-
pspのメモリースティックをpcで...
-
bd-rをフォーマット
マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング
-
SDカードを挿入すると「写真など...
-
SDカードの初期化(フォーマッ...
-
車で使用していた音楽用のSDカ...
-
コピーできないプロパティを持っ...
-
HDDからSSDへ換装するときにMBR...
-
SSDにフルフォーマットしてはい...
-
CDやDVDのフォーマットに...
-
快活クラブなどのネットカフェ...
-
フォマットできないSDカードを...
-
Windows11PCで、SDXCカードのフ...
-
CD-Rがフォーマットできなくて...
-
CD-RやDVD-RWのフォーマット/初...
-
プリンタのドライバーをUSB Fla...
-
SSDに不良セクタが出来たら不良...
-
ハイレゾの音楽をCDに焼くのは...
-
pspのメモリースティックをpcで...
-
PS4本体を初期化すれば、クレジ...
-
Macで使ったUSBメモリがWindows...
-
Mac用の外付けHDはWindowsPCで...
-
RaidのHDDを物理フォーマットす...
おすすめ情報