« 全体を見通す力をつける | メイン | 「工事進行基準」になった背景 »

SEが作るドキュメントについて

デジタルで文書を作成するのが常識になり、メールで即時納品も出来る世の中になりました。

しかし、それでも印刷したドキュメントは、必要なものです。

例えば、要件分析や基本設計のときに、ブレーンストーミングしたりする場合を除いては、顧客側も開発側も、互いに相手に説明するための資料(ドキュメント)を用意して会議に臨みます。

このドキュメントが、やがて要件定義書や基本設計書になるわけですが、ドキュメントの作成必須条件とは何でしょうか。

当たり前すぎるほど当たり前のことが幾つかあるのですが、どうも、「雛形」や「テンプレート」でドキュメントを作ることしか知らない人達には、必須事項として理解されていないことがあるようです。

1)どんな目的の資料かをはっきりさせ、意味なく余分な説明を入れない。

親切心から記入したとしても、その文章や説明が、逆に主な目的を曖昧にしてしまったりするのです。
複数の目的を兼ねた資料というのはマトリックスの表を除いては、むしろ良くないと思っています。

2)どんな場面で使われるのかを想定して作成する。

これに関しては、後で詳しく述べたいと思います。

3)タイトル、作成日付(更新日付)、ページ数・全ページ数をつける。

こんなことも知らない人がいるのか?とお思いでしょうか。
いえいえ、かなりいます。
一度、「雛型」無しで説明書きや報告書を作成されてみたらいかがでしょうか。

4)A4横または、A3横に統一する。

もちろんA4縦であっても良いとは思います。
要は印刷して閉じたときに、同じスタイルにできるように心がけるということです。
B4サイズの用紙は不適です。

5)図解やイラストを用いて一目で理解できたり、補足できるようにする。

6)1つの記号を複数の意味に使わない。

記号を使った図を描く場合には、丸やひし形、二重線で囲まれた四角などの意味を明確にするべきです。
さらに、記号の判例をつけなくてはなりません。

7)同じ注意書きをいたるところに書かない。

コピー&ペーストはミスの元凶です。
複数個所に書かないで、符号化して一か所にまとめて、統一的に扱いましょう。

8)とにかく記号・番号をつける。

年月日だけでなく、文書番号、段落番号、項番といったものを付けて、分類することで、一意のものとして特定できるように心がけましょう。
できれば、大→中→小→詳細といった場合に、その親の分類がわかるようなつけ方が望ましいものです。
例:
大分類 1. 2. 3. 4.
中分類 1-1. 1-2. 2-1. 2-2
小分類 1-1-1. 1-2-1. 2-1-2
※数字はこの分類だけにして、他の図や説明には、「a b c d」「(1)(2)(3)(4)」といったように、違う意味で同じ数字(記号)を使わないようにする、といったことも考えます。

他にも、フォントを揃える、フォントを9ポイント未満の大きさにしない、印刷物のパンチ穴を意識して余白を作る、ホッチキスで留める位置は左斜め上とする、…等々、細かいことを言い出したらきりがありません。

しかし、ルールを部下や他の人に徹底させることも重要ですが、何より、そのルールは、どういう理由で(Why)そうなっているのかを考えさせて、納得した理解をさせることが最重要だと思っています。

2)で挙げたように、その文書が「会議で資料として使われるもの」なのか、「最終確認用で配る」ものなのかによって、記入しなければいけない内容の精密さが変わってくるのです。

もし会議で資料として使われるものであれば、口頭で説明して頭にすっと入ってくるものについて、いちいち文章で書いてはいけません。

会議資料をたとえ前日に配っておいたとしても、会議の時間になるまで資料を読まない人は多いものなのです。

その場で字を読むことに集中したら、会議の意味は薄れてしまいます。

だから、会議で使う資料は、図や簡単な分類だけにとどめ、各自が同じ資料の同じ場所を見ていることを確認し、それぞれの顔を見て理解度を測りながら、口頭で説明することが望ましいのです。
そういった意味でページ数の表記や章番号は絶対必要なのです。

会議の出席者全員に、「自分の頭で考えて理解させる」そのための資料であるべきなのです。

時々、プレゼンテーション資料や会議資料に文章をツラツラと書き綴り、そのまま読み通す人がいます。

この場合、判を押したように、声は小さく早口になっています。

文章を読みあげるというスタイルで、出席者全員が理解し、納得することは無いということを知るべきです。

ただし、会議で使った資料を最終確認資料とする場合には、参加者の共通理解のある用語を使った文章で、確認に至った流れに沿ってまとめることが必要になります。

とにかく、どんなドキュメントにも、「目的」や「使用する場」があるのです。

読み手を意識したドキュメントを、ルールを守って応用的に作ることができてこそ、真のSEなのです。

Vol.00142

About

2008年04月22日 11:30に投稿されたエントリーのページです。

ひとつ前の投稿は「全体を見通す力をつける」です。

次の投稿は「「工事進行基準」になった背景」です。

他にも多くのエントリーがあります。メインページアーカイブページも見てください。

Powered by
Movable Type 3.38