いろいろな仕事を渡り歩き、今はインフラ系エンジニアをやっている。いろんな業種からの視点も交えてコラムを綴らせていただきます。

横向きドキュメントが気がかり

»

■ある事に気づいた

 どこの現場でもドキュメントを作る。最近、IT系の現場で作られるドキュメントにある共通点があることに気づいた。ほとんどのドキュメント(手順書以外)の用紙が横向きなのだ。

 必要最低限の内容は記載されているので、ドキュメントの最低ラインの用件は一応、満たしている。しかし、内容以前に横向きドキュメントの多さに何か違和感を覚えた。

■日常生活に見る縦と横

 まず、縦と横の話をしておく。これは誰が言っていたという話ではないが、ビジュアル的なものは横長、文章は縦長。そういう傾向がある。縦長のテレビ画面って一般的には無いです。また、用紙が横向きの文庫本も無い。一般的な本のほとんどが縦長だ。たまにある横長の本は大抵ビジュアル本だ。

 ここで1つ、不思議に思うことがある。一般に出てる技術書、解説書は用紙の向きが縦なのに、なんでドキュメントは用紙が横向きなのか。一般的な書籍ではのように用紙が縦向きなら、見開きで2ページ確認でき流れがつかみやすい。実際、ページがめくりやすいので前後関係の確認もしやすい。

■文章を書けないエンジニア

 もしかして、ドキュメントを作成する際、文章を避けてはいないだろうか。確かに、つらつらと文章を書くと内容は難しくなる。しかしIT系である以上、扱う対象にある程度の複雑さは必ず伴ってくる。簡単さばかり求めて、その複雑さに向き合えなくなったエンジニアが増えたんじゃないだろうか。

 実際のところ、現場で見かけるドキュメントの大半が図と表で埋め尽くされている。ドキュメントというより工事現場の設計図に近い。構成や設計は分かるが、文章の説明がないので内容が浅い。

 本屋に行ってみよう。専門的な本は、図を補助的に使って文章できちんと説明をしている。図と表中心なのは、操作方法を説明した入門書が中心だ。分かりやすいドキュメントも大事だが、図や表だけで済ますのはいただけない。

■図式を多様する本当の理由

 よく図で説明するとわかり易いと言われる。確かにそうだ。そこは否定しない。しかし、図を使えば安易に誤摩化せてしまう。表にデータを羅列して、適当に図を矢印でつないでいくと、それっぽいドキュメントが簡単にできてしまう。すぐに作れる。これが図式を多様する本当の理由のように思える。

 文章で説明するには、自分の中できちんと整理されている必要がある。図はイメージで書けるが、文章は明確に理解していないと書けない。このイメージと明確な理解の差は大きい。それがドキュメントの背景にあるものだとしたらどうだろうか?

 横向き用紙の図式中心のドキュメントが駄目だとは言わない。しかし、適当な図で誤摩化しているドキュメントほど、横向き用紙のExcel方眼紙だったりする。文章中心でドキュメントを書けるか。これは、きちんとドキュメントが書けるかの1つの指針として考えている。

Comment(0)