テクニカルコミュニケーション: 2008年6月アーカイブ

日本語のテクニカルライティングでは、操作と操作結果を別の文章にして分かり
やすくするという手法があります。
例えば、次のような書き方です。

1. [環境設定]ボタンをクリックします。
   [環境設定]ダイアログが開きます。

これに対し、Microsoft Manual of Style Third Edition では、次のような記述が
あります。

Avoid explicit descriptions of system responses. If necessary to orient the reader, include the response in the step or the one immediately following.

つまり、「操作結果の説明は避けること。説明する必要がある場合は、操作と一緒に
書くこと。」ということになります。これに従うと、上記は以下のようになります。

1. Click Preferences.

「[環境設定]ダイアログが開きます。」は、実際に操作してみれば分かることなので、
書かないことになります。物事を丁寧に説明することを好む日本人にとっては、
抵抗があるかもしれません。

「[環境設定]ダイアログが開きます。」をMicrosoft Manual of Styleに従って
入れるとしたら、どう書くのでしょうか。以下のようになります。

1. Click Preferences to open the Preferences dialog box.

日本語テクニカルライティングと英語テクニカルライティングでは、
このように対立するような考え方があったりします。

一文一文翻訳していると、対象言語のテクニカルライティング手法に
そぐわない文章ができてしまういい例です。