テクニカルライティングは、製品マニュアルを書く仕事です。
その経験から、いろんな仕事に役立つ教訓がありました。
皆様のお仕事の参考になれば幸いです。
１番のコツは短く書くこと！
テクニカルライティングの基本です！
文章は長くなるほど、わかりにくくなり、誤解を招きやすくなります。
１文の長さは、40～50文字以内
文章が長くなると、主語と述語が対応しないミスも犯しやすくなります。
（例）
DHAが多く採れる魚は、イワシなどの青魚、青魚以外ではマグロのトロや目の裏の部分にも含まれています。
どこがおかしいかわかりますね、主語と述語が対応していません。
DHAが多く採れる魚は、、、、、、、、、、、含まれています。
DHAが多く採れる魚は、イワシなどの青魚です。
青魚以外ではマグロのトロや目の裏の部分にも含まれています。
２文に分ければミスを犯すことはありません。
一動作一手順
手順を書く時は、一動作一手順が基本、そして動作と結果は分けてください。
［準備］ボタンを押すと、装置は準部動作を開始し、準備動作が完了すると［準備完了］完了ランプが点灯するので、［スタート］ボタンを押してください。
⇓
1.［準備］ボタンを押します。
・準備動作を開始します。
・準備が完了すると［準備完了］完了ランプが点灯します。
2.［スタート］ボタンを押します。
手順を書く時の鉄則、驚くほどわかりやすくなります。
箇条書きを活用する
再生するときは、【再生】ボタンを押します。停止したいときは【停止】ボタンを押し、一時停止したいときは【一時停止】ボタンを押します。早送りしたいときは【早送】ボタンを押し、巻き戻したいときは【巻戻】ボタンを押します。
⇓
ボタンの機能を説明します。
・【再生】ボタン ：再生を開始します。
・【停止】ボタン ：再生を開始します。
・【一時停止】ボタン ：再生を一時停止します。
・【早送】ボタン ：早送りで再生します。
・【巻戻】ボタン ：再生を巻き戻します。
箇条書きは、文書を簡潔にします。
不要な語句を削る
文字の入力方法がわかったら、これから実際に例文を作ってみましょう。
⇓
文字の入力方法がわかったら、例文を作ってみましょう。
ローマ字漢字と仮名漢字の2種類の異なった入力方法があります。
⇓
ローマ字漢字と仮名漢字の2種類の入力方法があります。
同じ言葉や名称は繰り返さない
⇓
写真を印刷するときは、専用紙を使ってください。
写真は、専用用紙に印刷してください。
⇓
このソフトウエアは、写真を自動補正します。
設置する場所は、直射日光が当たらない場所を選んでください。
⇓
直射日光が当たらない場所に設置してください。
少し意識すれば誰でもできます。
文字壁は最悪
紙に文字がびっしり埋まっているマニュアル、見ただけで読む気が失せます。
読まれなければ意味がない！
文字の壁は読む気を遮る壁、余白を大切にしてください。
版面率は70％！
教訓、短く書くことは幼稚ではない！
短い文は、決して幼稚ではありません、勘違いしないでください。
読む気がしない、伝わりずらい、誤解されやす文書が最悪です！
たとえば、連絡事項も、一つの文には一つの内容で書くとすっきりします。
（一文一義）
週末に予定されいるイベントについてですが、もし雨天の場合は中止になりますので、その際には当日の午前９時までにメールでお知らせします。
⇓
週末に予定されているイベントのお知らせです。
雨天の場合は、中止になります。
イベント当日の午前９時までにメールで連絡します。
あなたの文書を自動でチェックしてくれます。
