Software Design 誌12月号でエンジニアの「書く力」特集を書きます
»
(株)技術評論社から出ているSoftware Designという雑誌の12月号（11/18発売）で、特集記事を書くことになりました。
仮タイトルは、
なぜエンジニアは文章が下手なのか？
――ドキュメント、図解能力向上講座
です。
うむぅ。いやいや、文章が下手なのはエンジニアだけじゃないんですけどね、僕に言わせれば。
エンジニアは本当に文章が下手なのか？
と、こんなタイトルも考えているところで、確定はもう少し先。
というわけでタイトルはまだ仮ですが、テーマとしては「文書を書く」ことなのは確定です。
書く、といってもいろいろな書類があります。
数行程度のちょっとした業務連絡メール（「昨日、予備機にて○○作業を実施した結果・・・」というようなもの）もあれば、「○○業務基本設計書」のようにカタイ名前で表紙・目次つきでドーンと数十ページかそれ以上の文書になるものもあり、あるいはパワポで作る数ページ～十数ページのプレゼン資料もあり、ものによって中身はいろいろですが、総じて
エンジニアは文章が下手
と思われているらしい、ということは言えます。
それは一部は事実で一部は誤解でしょう。
で、そのどちらにしても、そのままにしておくのは不幸なことなので、何かしら手を打ちたい。
というわけで私が特集記事を書くことになりました。
まだ構想がぜんぜん固まってないのでアバウトに「こんなネタ書こうかなあ」というネタを挙げてみます。
■エンジニアは文章が下手って、ホントかよ？
一部は事実で一部は誤解。事実として確かに「文章を書く」ことに慣れてない面はある。
しかし誤解も多い。人間は自分が知らないもの、見慣れないものについては難しく、わかりにくく感じる。それが「下手だコイツ」という評価につながりやすい。ソフトウェア・エンジニアよりはユーザーのほうが数的に圧倒的多数なので、非エンジニアから見れば「下手」と見えやすいしそれが多数だからそのまま常識になりやすい。そういうところは誤解にもとづくものであり、本来はユーザー側の読解力の弱さこそ問題だ（・・・なんて書くとツッコまれそうだなー）。
■分かりやすければいいってもんじゃないよね
「わかりやすい」ことすなわち良いこと、という空気が世の中に存在するのは実に実にケシカラン。
いくら分かりやすくたってそれが嘘だったり、あるいは誤解されやすくなってたらダメだろ・・・。
「一見分かりやすく見える説明」って、細部を省いた単純すぎるイメージで出来てることがよくあって、そういうものは嘘や誤解の温床なんだよ？ ということを私は強く強く主張したいのであ～る。
■無理に「文章」を書くのはやめようよ
「なぜエンジニアは文章が下手なのか？」というタイトルにも「文章」という単語が使われているけれど、そもそも必要なのは「文章」ではなく「文書」である。無理して「文章」にするよりも、個条書きや図表で書いたほうが書くのも簡単、読んでも明快、というケースは非常に多いのだ。
人にものを伝えるのには内容に応じて最適な表現を使えば良いので、それは必ずしも「文章」だけではない。
■文書の種類によって、明示すべきポイントが違う
・OK・NGの判断をもらう文書→何についての判断をもらいたいのか、という議題、選択肢、選択の手がかり、根拠など
・手順への理解を得る文書→全体と部分の位置関係がわかる表現（フローチャート等）と、細部の注釈
・疑問を持たせる文書→分かっていることとわからないことを明示し、わからないことに意識を向かわせる
・やりたいな、と思わせる文書→明るく楽しいイメージ、空気
■用語の選択には気を使え
「わからない用語」が2つ以上溜まると、理解のハードルが一気に上がる。そのため、背景知識のない人向きの説明書を書く時は、専門用語を使う順番に気を使うこと。一見専門用語ではなくても、人や業種業界によって違う意味がある用語もあるので要注意。
■図解の作業は分解・分類・整列・ラベリング
図解には決まった手法があるわけじゃない。地道に分解・分類・整列・ラベリングを繰り返すこと。
文章が上手くなるためにもそれが大いに役に立つ。いやホントにそうなんですよ。
・・・・・・・・・といったネタをただいま構想中。第一特集で、私の担当分は32ページほどになる見込みです。
ご意見ご要望絶賛大募集中につき、何か一言ある方は twitter や facebook やメールでメッセージ送ってください。
仮タイトルは、
なぜエンジニアは文章が下手なのか？
――ドキュメント、図解能力向上講座
です。
うむぅ。いやいや、文章が下手なのはエンジニアだけじゃないんですけどね、僕に言わせれば。
エンジニアは本当に文章が下手なのか？
と、こんなタイトルも考えているところで、確定はもう少し先。
というわけでタイトルはまだ仮ですが、テーマとしては「文書を書く」ことなのは確定です。
書く、といってもいろいろな書類があります。
数行程度のちょっとした業務連絡メール（「昨日、予備機にて○○作業を実施した結果・・・」というようなもの）もあれば、「○○業務基本設計書」のようにカタイ名前で表紙・目次つきでドーンと数十ページかそれ以上の文書になるものもあり、あるいはパワポで作る数ページ～十数ページのプレゼン資料もあり、ものによって中身はいろいろですが、総じて
エンジニアは文章が下手
と思われているらしい、ということは言えます。
それは一部は事実で一部は誤解でしょう。
で、そのどちらにしても、そのままにしておくのは不幸なことなので、何かしら手を打ちたい。
というわけで私が特集記事を書くことになりました。
まだ構想がぜんぜん固まってないのでアバウトに「こんなネタ書こうかなあ」というネタを挙げてみます。
■エンジニアは文章が下手って、ホントかよ？
一部は事実で一部は誤解。事実として確かに「文章を書く」ことに慣れてない面はある。
しかし誤解も多い。人間は自分が知らないもの、見慣れないものについては難しく、わかりにくく感じる。それが「下手だコイツ」という評価につながりやすい。ソフトウェア・エンジニアよりはユーザーのほうが数的に圧倒的多数なので、非エンジニアから見れば「下手」と見えやすいしそれが多数だからそのまま常識になりやすい。そういうところは誤解にもとづくものであり、本来はユーザー側の読解力の弱さこそ問題だ（・・・なんて書くとツッコまれそうだなー）。
■分かりやすければいいってもんじゃないよね
「わかりやすい」ことすなわち良いこと、という空気が世の中に存在するのは実に実にケシカラン。
いくら分かりやすくたってそれが嘘だったり、あるいは誤解されやすくなってたらダメだろ・・・。
「一見分かりやすく見える説明」って、細部を省いた単純すぎるイメージで出来てることがよくあって、そういうものは嘘や誤解の温床なんだよ？ ということを私は強く強く主張したいのであ～る。
■無理に「文章」を書くのはやめようよ
「なぜエンジニアは文章が下手なのか？」というタイトルにも「文章」という単語が使われているけれど、そもそも必要なのは「文章」ではなく「文書」である。無理して「文章」にするよりも、個条書きや図表で書いたほうが書くのも簡単、読んでも明快、というケースは非常に多いのだ。
人にものを伝えるのには内容に応じて最適な表現を使えば良いので、それは必ずしも「文章」だけではない。
■文書の種類によって、明示すべきポイントが違う
・OK・NGの判断をもらう文書→何についての判断をもらいたいのか、という議題、選択肢、選択の手がかり、根拠など
・手順への理解を得る文書→全体と部分の位置関係がわかる表現（フローチャート等）と、細部の注釈
・疑問を持たせる文書→分かっていることとわからないことを明示し、わからないことに意識を向かわせる
・やりたいな、と思わせる文書→明るく楽しいイメージ、空気
■用語の選択には気を使え
「わからない用語」が2つ以上溜まると、理解のハードルが一気に上がる。そのため、背景知識のない人向きの説明書を書く時は、専門用語を使う順番に気を使うこと。一見専門用語ではなくても、人や業種業界によって違う意味がある用語もあるので要注意。
■図解の作業は分解・分類・整列・ラベリング
図解には決まった手法があるわけじゃない。地道に分解・分類・整列・ラベリングを繰り返すこと。
文章が上手くなるためにもそれが大いに役に立つ。いやホントにそうなんですよ。
・・・・・・・・・といったネタをただいま構想中。第一特集で、私の担当分は32ページほどになる見込みです。
ご意見ご要望絶賛大募集中につき、何か一言ある方は twitter や facebook やメールでメッセージ送ってください。
SpecialPR