書いて楽しい、見て楽しい、しかもわかりやすい仕様書の書き方ってどんなものがあるでしょうか?

私は家電のソフト屋ですが、あまり堅苦しく書かれても読みにくいし・・・。
ウチではこんな試みしてるよー なんてお話もあれば聞かせていただきたいです。

回答の条件
  • 1人2回まで
  • 登録:2008/02/17 21:50:07
  • 終了:2008/02/24 21:55:03

回答(4件)

id:fumikef No.1

fumikef回答回数41ベストアンサー獲得回数22008/02/17 23:47:30

ポイント23pt

ソフト屋ということなので、おそらくプログラム仕様書全般のことを仰ってるんだと思いますが、間違っていたらすみません。


プログラム仕様 - Wikipedia


上の Wikipedia の古典的な分類を例にするなら

  • 基本仕様
  • 機能仕様
  • 詳細仕様

などがあると思うのですが、このどれについても使えて、奇麗にまとまって見えるように書くポイントとして私が気をつけていることは、以下のようなものです。

(よくある話しかもしれませんが・・・)


  • 図や式を多用(特に全体をフカンで眺めるような物を必ず最初に配置)
  • 可能な限り箇条書きにする
  • 無理な場合は表形式にする(そしてセル内も箇条書き)
  • あまり長い説明文を書かないこと(補足・注釈程度はしょうがない)

ヨコですが「しょうがない」は、漢字にすると「仕様が無い」です。

更にヨコですが「くだらない」などの意味で使う「しょうもない」も、漢字にすると「仕様も無い」です。


ただし、私は、誤りなく伝えることができる書き方をする事こそが大事だと思います。できるだけ短く書こうとして、その為に別の意味にも読めてしまう書き方にならないように注意が必要ですね。


仕様書は、依頼主への提出する為だけの物ではなくて、後で運用・保守・改訂作業を行う際に無くてはならない物ですから。(ソフト屋さんでしたら判ると思いますが)特に、後から忘れた頃にやってくる改訂で、仕様書が揃っていないと非常に苦労することになります。

id:shikaku

誤りなく伝えるために、読む気にさせるのも重要なのかなぁと思ってます。

運用・保守・改訂作業がまたしんどいです。なんとか楽しい作業にしたいですよね。

2008/02/22 07:10:16
id:hrkt0115311 No.2

どんジレ、どんさん回答回数892ベストアンサー獲得回数512008/02/18 11:06:02

ポイント23pt

こんにちは。


仕様書の書き方って,習いました? - 日経エレクトロニクス - Tech-On!

http://b.hatena.ne.jp/entry/http://techon.nikkeibp.co.jp/article...

もうご存じかもしれないですが、上記が参考になるかと思い、紹介させていただきます。

また、簡潔に説明することも、あるていど量のある説明をすることにも使える点で、CPAN http://search.cpan.org/ のフォーマットが見易いのではないだろうかと考えました。専門家の方にご紹介するのは釈迦に説法で気が引けるのですけれども、よろしければご参照下さい。



以上、参考になれば幸いです。

id:AZUY No.3

AZUY回答回数343ベストアンサー獲得回数122008/02/18 13:41:30

ポイント22pt

こんにちは

* 基本仕様

* 機能仕様

* 詳細仕様

該当箇所の機能を上から順番に読めば仕様を理解できると言う書き方が、

わかりやすい仕様書だと思います。

状況にあった詳しさをで抑えられてるほうが、理解もしやすいですし・・。

=>書いて楽しい、見て楽しい

私もこれに関心があります。

いままで、書いて楽しいと思ったこともないし、

見て楽しいと思った仕様書もありません。

id:shikaku

>見て楽しいと思った仕様書もありません。

やっぱりないですかぁ。

どこかにはあると思うんですよねぇ

2008/02/22 07:18:23
id:dachii No.4

dachii回答回数1ベストアンサー獲得回数02008/02/19 00:07:48

ポイント22pt

こんにちは。

楽しいがポイントということですので、小説風に書くのはいかが?

小説ぽく、いきいきと記述。仕様書のユースケースや機能説明といったところではよいかも・・。

もとはJoel on Softwareからヒント。機能仕様書サンプルのシナリオのところです。

http://japanese.joelonsoftware.com/PainlessSpecs/WhatTimeIsIt_Jp...

あとは、ゆるーい手書き風フォントをいれて、テクニカルノートやメモ、ふきだし満載の仕様書にするとか。

#どっちもチャンスをうかがっているところで、まだ試したことはありませんが:-)

id:shikaku

Joel on Software は私も好きです^^

>あとは、ゆるーい手書き風フォントをいれて、テクニカルノートやメモ、ふきだし満載の仕様書にするとか。

全部マンガでかくとか考えたことありました:-) 絵を多様すると読むための敷居が下がる気がするんですよね。

子供でもわかる仕様書みたいなの 作れないかなぁ

2008/02/22 07:38:27
  • id:fumikef
    仕様書としての役目を十分に果たしつつ、かつ、わかりやすくて、楽しいものということでしょうか?難しいですね。

    その仕様書さえあれば、誰か作っても同じ機能を持ったソフトを作ることができる。

    というのが仕様書として必要十分な条件だと思っています。なので、正直「目標を満たす」だけでも難しく、「わかりやすく」を盛り込みつつ作るだけで手いっぱいで、「楽しさ」まで手が回りませんね。

この質問への反応(ブックマークコメント)

トラックバック

「あの人に答えてほしい」「この質問はあの人が答えられそう」というときに、回答リクエストを送ってみてましょう。

これ以上回答リクエストを送信することはできません。制限について

絞り込み :
はてなココの「ともだち」を表示します。
回答リクエストを送信したユーザーはいません