短期間で上達できるテクニカルライティング

コツを知れば短期間で上達します

少し気を配ると読みやすくなります

<その2:短く普通の言葉で書く> 

  • 短い文章で書く
  • 一文一義で書く
  • 箇条書きを活用する
  • 長々した表現は使わない
  • 誤解を招く、高尚な言い回しは使わない

中学生レベルの簡単な文章を書けばよいことを書きました。

読みやすくするために、少し気を配って欲しいことがあります。

f:id:openup21:20210811091959j:plain

少しの気遣いで読みやすく

1. 能動態と受動態を使い分ける

・[戻る]ボタンが押されると、ホーム画面を表示します。

・[OK]ボタンが押されると、データを書き換えます。

   ⇓どちらも間違いではありませんが、

・[戻る]ボタンを押すと、ホーム画面が表示されます。

・[OK]ボタンを押すと、データが書き換えられます。

  • ユーザー使用者の行為は能動態
  • 機械や装置の動作は受動態

手順でも同じです。

1.[戻る]ボタンを押します。
 ・ホーム画面が表示されます。

1.[OK]ボタンを押します。
   ・データが書き換えられます。

2. 否定文は肯定文に置き換える

否定的な表現は使用者が不安になります。

・画面が表示されいる状態で、
 メインスイッチを切断しないでください。

どうすればよいのか具体的に書くと安心します。

・[画面消去]キーを押して画面を消灯してから、
  メインスイッチを切断してください。

3. 「など」を使わない

カミナリ警報が出ている地域は、石川県、福井県富山県などです。

と言われるとどうですか。

もし新潟県に住んでいる方が見ると、
など?新潟県も入るの?と思います。
技術文書では、あいまいな表現「など」は使わないでください。

4. 同じ語句はわない

一文内に同じ語句があると読みづらくなります。

パラメータの種類は、全部で5種類です。

   ⇓

パラメータは、全部で5種類です。

設置する場所は、直射日光が当たらない場所を選んでください。

   ⇓

直射日光が当たらない場所に設置してください。

写真を印刷するときは、専用用紙に印刷してください。

   ⇓

写真は、専用用紙に印刷してください。
   or
写真を印刷するときは、専用用紙を使ってください。

少し文を変えてスッキリさせてください。 

5. 読点を上手く使う

読点は文を読みやすくするだけでなく、
係受けをハッキリさせる役割があります。

生産性向上に貢献する〇〇〇〇機能と■■■■機能

(貢献するのは両方?片方?わかりません)

   ⇓

生産性向上に貢献する、〇〇〇機能と■■■■機能

(貢献するのは両方とハッキリします)

f:id:openup21:20210714123343j:plain

スッキリ、流れるように、、

5. 「行う」に注意する

実験を行う           ➡ 実験する

処理を行う           ➡ 処理する

製造を行う           ➡ 製造する

この表現は間違っていませんが、
技術文書ではまだるっこしく感じます。

6. 「から」と「より」

B点より15㎝離れた位置に設置してください

   ⇓この表現は間違っていませんが、

B点から15㎝離れた位置に設置してください

  • 「から」は比較
  • 「より」は比較
    ※「より」は、少し古臭い感じもします。

7. 文末の表現は統一

ですます調など、文末の統一は当たり前ですが、

長い技術文書では、見過ごされることがあります。

  • ~しても構いません。
  • ~しても問題ありません。
  • ~することも可能です。

このような混在、時折見かけます。

どれもむずかしい内容ではありません。
しかし、意識しないとやってしまいがちです。

f:id:openup21:20210811155621j:plain
f:id:openup21:20210818121431j:plain
手書きでは起きないことが起きる、、、

パソコン、特にワードのスキルはライターには必須です。
書式スタイルを使えることが大切です。
スペースや改行で位置を揃えているのであれば注意が必要です。