Some Days You Get the Bear

IT系エンジニアの、日々の気づきや考えたこと。

仕様書の書き方

仕様書とコードの大事な関係

仕様書に書いてあることは、そのままコードに落としたい。そのためにも、仕様書とコードを1対1で対応させたい、と思う。つまりは、「仕様書のここは、このクラス/モジュールに書いてあります」としておきたい。そして、その中身は、 「2-3章の機能は、こ…

書く能力、話す能力 -仕様書の書き方(3)

仕様書の書き方のことを何度か書いたが、 まず出発点は「口で説明できること」なんだと思う。話し言葉でちゃんと伝えることができるということは、 話す前に、あるいは話しながらでも、 話す内容がきちんと整理できていて、伝えるための言葉の用意ができてい…

まずは「箇条書き」でしょ! ~仕様書の書き方~

仕様書の書き方、第2弾です。漏れ抜けのないようにと、あれもこれもと盛り込みたくて、 ついつい長文になってしまうこと、けっこう多いように感じています。しかし、仕様書は、まずは「箇条書き」です!要素をきちんと分解し、1つのことを1つの項目として…

仕様書の書き方はどうやっておぼえるのか

(仕様書というよりは)資料を書くときにごく普通に意識していること。■言葉を統一する 同じものを指すのなら、常に同じ言葉で書き表す。■初出のものには説明を 重要なもの・ことについては、章を割いて説明する。 読み手の前提知識がどの程度で、どこまで説…