2006年03月04日(土)

YYYY/MM/DD

テーマ:設計
「YYYYMMDD」形式で今日の日付を表せば、「20060304」である。

この「YYYYMMDD」のような表現方法は、この業界では共通の認識だと思う。

日付を8桁の固定長で表現するために、月や日が1桁の場合は前に「0」をつけて2桁をつける。1桁のままだと「1月12日」と「11月2日」が両方とも「112」になり、区別できないからだ。・・・などということは、あらためて書く必要もないことだろう。

このことから、「MM」や「DD」という表現は、日付の月や日を2桁で表記するという意味であることが分かる。

しかし、先日、ある設計書の中に、それをあえて打ち消すような表現を見つけた。

 YYYY/MM/DD形式(MM、DD は、1桁の場合には1桁で出力)

つまり、「2006/03/04」ではなく、「2006/3/4」と表すということだろう。

しかし、そのような場合、「YYYY/M/D」と書くのが普通ではないか? Excel の書式設定でもそうなっている。

おそらく、設計書を書いた人は「YYYY/MM/DD」と「YYYY/M/D」の使い分けなど知らなかったのだろう。このような「常識のズレ」とは恐ろしいもので、そのままバグに繋がることもある。

しかし、私は、彼がその代わりに「1桁の場合には云々」という但し書きを付け加えたことを評価する。これなら、誤解されることはまずない。むしろ、「YYYY/M/D形式」とだけ書くよりも意図が明確に伝わるかもしれない。そういう意味では、この1行はよく書かれているといってもいいと思う。

専門的知識が少ないとか、語彙が少ないとかいったことは、ある程度は仕方がない。技術文書を書く上でもっと重要なことは、誤解されずに意図を伝えることである。常に「この表現で誤読されないだろうか?」などと考えながら書くことが大切なのである。




← このブログを誰かに読ませたいと思った方は、クリックを


■関連記事
コンピュータに興味がないプログラマ
どこまで書くか設計書



SEを極める 仕事に役立つ文章作成術―百戦錬磨のプロマネが伝授するドキュメント作成の極意
福田 修 日本情報システムユーザー協会
日経BP社 (2005/11)

コメント

[コメントをする]

1 ■無題

お小遣い稼ぎについてのサイトです。

2 ■はじめまして

はじめまして

記事を拝見しました

「常識のズレ」共感です。自分があっていると思っても間違っていたりすることもあるので、気をつけたいところです(汗)

なかなか深いサイトですね!

これからも記事を楽しみにしています

ではまた訪問します

3 ■RE: はじめまして

SEが薦める役に立つ フリーソフト & ソフトさん、はじめまして。
とはいえ、私も、そちらのサイトは人気blogランキングで知ってました。
今後ともよろしくお願いします。

4 ■初めまして。

初めて投稿させていただきます。

今回の記事には激しく同意です!
この業界で設計者とのたまう方々に、このような気の利いたことが出来る人は大変少ないと感じています。

納品のための設計書ではなく、製造するための設計書を作る。
当たり前に思うことでもなかなか難しいですよね、これが・・・(^-^;

5 ■RE: 初めまして。

そういちろうさん、はじめまして。
設計書の読者は顧客だったり、プログラマだったり、テスターだったりしますから、難しいですね。

コメント投稿

一緒にプレゼントも贈ろう!

Amebaおすすめキーワード