テクニカルノートって

  技術資料っていろんな意味があると思います。ボクは以前仕事で資料書きみ
たいなこともやってましたが、会社や業界によっていろんな進め方があるので
すよね。この点でいちばん良い例が航空界だとおもいます。

  飛行機についての、いちばん詳細な技術資料というと、設計図ということに
なります。製作図面から、計算書まですべてを詳細に見れば、すべてが判るは
ずですが、現代の航空機はこれだけでは飛ばせません。図面を詳細に読めば判
るかもしれないけど、誤解される恐れのあること、図面では表れないこと、設
計時の見落としや誤りがあります。プログラムでいえば、リストのような物で
す。これは、ふつうは、公開される物ではありません。

  そこで、実際の使用に合わせた説明書が必要になります。これは、通常の使
用を想定しつつ、いろんなケースに合わせて作られます。たとえば、整備の手
引きや、飛行前の点検表といった物です。これらは、モデルケースに従って、
シミュレータや試験をもとに作成されます。この中には、事前に予想される問
題と解決方法といった物も含まれます。ま、一般のユーザ向けマニュアルです
ね。今日では、パイロットがエンジンを分解したりすることはありません。

  この他に、特殊なケースや、非常時、メンテナンスなどを対象とした、手順
書が作られます。これは、専門の技術者向けで、ふつうはパイロット等が必要
とすることはありません。これは、ソフトで言えば、仕様書にあたると思いま
す。ローダを作成するとか、凝ったデータを作るには必要でしょうが、これを
すべて理解しなくても、通常は使える訳です。

  ところが、実際に運用して行くと、予想外のトラブルや、過失や、勘違いが
おこります。これに対しては、定期的あるいは臨時に『ノータム』が出るので
す。たとえば、『ある高度以下では、こうする時には、自動を解除せよ』とか、
『○○と××を同時にセットすると不安定になる』といった注意事項、『この
部品を交換した時には、パッキンを入れ忘れないように』といった物もありま
す。これらは、実際の使用上の経験をもとに、アドバイスとして出されます。
  また、不具合が発見されると、『マニュアルには、××の点検は５０００時
間ごとと書いてあるが、とりあえず５００時間ごとに検査せよ』といったのが
出ます。最悪のケースでは、『△△の機能は対策が行なわれるまで使用禁止』
というのもあります。

  この最後のノータムというシステムが定着したおかげで、今日の複雑な航空
機を飛ばせるようになったと言えると思います。完全なマニュアルなんかは半
永久的にできないし、詳細なマニュアルを読んでもかえって混乱するし、明確
な指針がないと、同じようなトラブルがあちこちで起きることになります。
  ノータムが有効になったポイントは、使用者に迅速に届くようになったこと
です。今日では、数年前に比べて、パソコン利用者の環境が大きく変わってい
ます。マニュアル１つを頼りに一人で挑むというのではなく、いろんな人の状
況を見ながら協力して進められると思うのです。この点で、Ｎｉｆｔｙの会議
室やホームページはたいへん有効だと思います。

  現実的なことでは、 (1)設計図面はあります。 (2)一般ユーザ向けのマニュ
アルは早急に欲しいですね。 (3)テクニカルドキュメントは、データフォーマ
ットとか文法書ぐらいで良いでしょう。これは、そんなに急ぐものではありま
せん。 (4)その上で、使用上のガイドラインを随時発行して補うというのでは
どうでしょう。

   (2)については、一般のデータ作者さん向けですから、実際的な表現で、機
能の概要を説明したあと、『クリックしたら画像が替わるには、どう書くか』
といった例文集で良いと思います。

	ボクは、どっちかと言うと、プログラム書きながら、ドキュメントを
	書くタイプなんですよ。文章化しながらいろんなケースを想定してゆ
	くと、処理の手順とかが明確になってゆくので。

					ＭＡＲＳ