オルタナティブ・ブログ > 技術屋のためのドキュメント相談所 >

専門的な情報を、立場の違う人に「分かるように説明する」のは難しいものです。このブログは「技術屋が説明書や提案書を分かりやすく書く」ために役に立つ情報をお届けします。

スタート/ゴール/メカニズム/メソッドの考え方

»

こんにちは。ドキュメント・コンサルタントの開米瑞浩です。

前回、SQLの結合条件と抽出条件に関する技術解説をリライトした例を書きました。

この種の解説を書く場合の基本パターンなのですが、

スタート/ゴール/メカニズム/メソッド

の4項目を考えます。

「スタート」状態のものを「ゴール」状態に変化させる(下図の黒矢印)のが目的。そのために、「メソッド」という手を打つこと(下図、赤矢印)。そのメソッドには前提とする「メカニズム」があること。簡単な図にすると下記のようなイメージで、これらが「技術解説」の最も基本的な要素になります。

2015-1109-1.PNG
 

超簡単な例を出すと、たとえば「ゆで卵の作り方」をこのパターンで整理すると

スタート:生卵
ゴール:ゆで卵
メソッド:生卵が浸るまで水を入れた鍋を火にかけ、沸騰させて10分ゆでた後、冷たい水に3分さらす
メカニズム:卵に含まれるタンパク質は70度以上で固まる性質がある

ということになります。

技術解説を「わかりやすく」するためには、スタート、ゴール、メソッド、メカニズムのそれぞれをイメージしやすい形で提示する必要があります。

前回私が書いたものでは、

スタート = "例題"
ゴール = "求める結果"
メソッド = "よくある間違い"(誤答例)、 "正しくは?"(正答例)
メカニズム = "2種類の「抽出」操作の違いに注意"

にそれぞれ対応します。

前回記事はこれらを「イメージしやすい形で提示する」ためにいろいろと工夫をしたものです。

ちなみに、「技術解説」系の文書でも、中には「メカニズム」や「スタート」を書いていないものがよくあります。

たとえば、前述の「ゆで卵の作り方」でも、普通のお料理レシピとしての情報には「メカニズム」の部分は必要ないし、「スタート」は生卵であることがわかりきっているので、省略されることが多いのです。

メカニズムを知らなくても、「メソッド」だけ知っていれば、「今までと同じ仕事」はできます。もちろん、原理を知らないと応用は効きません。たとえば、ゆで卵のレシピだけ知っていても、半熟卵や温泉卵は出来ません。

メカニズム(原理)というのはこの場合は「卵の黄身と白身のタンパク質の、温度による凝固特性の違い」です。そうした原理的なところを知っていれば、半熟卵と温泉卵の作り方を自分で考えることができます。もちろん、「半熟卵レシピ」「温泉卵レシピ」として誰かが「メソッド」化してくれた情報を知れば、それを作ることはできますが、他人が作ったメソッドを覚えて使うのは「応用」とは言えないでしょう。

ですから、「技術者」を育てるのであれば必ず「メカニズム」を教える必要があるし、さらに言えば「メソッドを教えずにメカニズムの知識をもとに考えさせる」ような訓練が必要なのですが、そうした教え方は手間暇がかかります。そのため、「決まった作業をさせるオペレータがいればいい」という環境では、メカニズムを省略したマニュアルを作って「やらせる」という形で業務を回していることがあります。それが悪いとは言えませんが、それで技術者が育つわけではない、ということはわきまえておきたいですね。

Comment(0)