テキストコミュニケーション力を磨く、エンジニアのためのテクニカルライティング - 「実用文と読者層」
はじめまして
現役エンジニアのたくみです
足を運んでくださりありがとうございます
この記事は以下の悩みを解決するために書きました
この記事の対象者
- わかりやすいドキュメントを書きたい
- Chatツールのやり取りをスムーズに行いたい
- 誤解のない指示やお願いをしたい
参考書籍
この記事を書こうと思った理由
「誤解のない文章を作れるようになり、コミュニケーションコストを下げる」ために、どうしたらいいかを思考する上で、良書に出会ったので記事を書くことにしました
私は過去に文章で誤解を与えたり、誤解をしたりする経験をしています
エンジニアリングにおいて誤解は致命的になるケースが結構あります
例えば、「エンジニア同士のソフトウェアの仕様の認識が違った」など
Slackのやり取りの回数が多いと、誤解を招いたりするケースもあるでしょう
やり取りの回数が多ければ多いほど、情報が拡散され、見逃しも増えていきます
Slackのやり取りだけで半日潰れてしまった・・・
と言う経験をしたことがある人も少なくないでしょう
1.テクニカルライティングとは
です。
実用文とは
特徴
- 対象となる物事について説明している
- 論理的である
- 誤解を生まない
- 簡潔で明快である
- 読みての行動を促す
- 成果物が文章である
この特徴は「そりゃ大切なことだ」と思わせられます
さらに
とあります
ドキュメントやメール文、チャットのやり取りなどで、
誰が、いつ（いつまでに）、何を、どうする
が、読者に正しく認知されることが重要です
具体例
件名：停電のお知らせ
日々の業務お疲れ様です
管理部の管理太郎です
2024年11月20日（水）21時より、当ビルは点検のため停電をいたします
全員20時半までには完全退社をお願いいたします
また、以下に該当する方々は、後述する業務を実施し、退社するようにお願いいたします
対象者
- 20時以降の勤務をするかた
- PCを扱う方
上記に当てはまる方は、退社前に以下業務をお願いいたします
- 20時以降の勤務をするかた
- Wi-Fiの電源を抜く
- 冷蔵庫の電源を抜く
- PCを扱う方
- PCのシャットダウン
残っている方々で声を掛け合って上記の対応をお願いいたします
くれぐれも21時以降社内に残らないように注意をお願いいたします
以上、管理部からのお知らせでした
我ながら例文を書いてみて成長を感じます
この例文を使いながら、テクニカルライティングについて紐解いていきたいと思います
2.読者層を決めてから書く
例文で言うと以下の部分になります
全員20時半までには完全退社をお願いいたします
また、以下に該当する方々は、後述する業務を実施し、退社するようにお願いいたします
対象者
- PCを扱う方
- 20時以降の勤務をするかた
なぜ読者層を決めるのか
これは、「文章は相手の時間をいただく」からです
読み手の人も自分と同じく、時間を使って文章を読みます
例えば、読者層を排除してみるとどうなるでしょう
件名：停電のお知らせ
日々の業務お疲れ様です
管理部の管理太郎です
2024年11月20日（水）21時より、当ビルは点検のため停電をいたします
20時半までには完全退社をお願いいたします
退社前に以下業務をお願いいたします
- Wi-Fiの電源を抜く
- 冷蔵庫の電源を抜く
- PCのシャットダウン
こんなメールがきたら、きっと質問がたくさん出てきます
「質問をする」ということは、質問者と、回答者、それぞれに文章の読み書きの時間が使われます
また、以下に関しては、関係のない話です
- 18時に退社する人
- PCを使わない人
文章には
ということです
読まなくていい人の時間を奪ってしまい、さらに、対象外の人から質問が来たら、自分自身も解答に時間を使い、コミュニケーションコストが増えていきます
そういった理由から、
ことが重要です
今回はここまでとします
次回は「期限と優先度について書こうと思います
テキストコミュニケーション力を磨く、エンジニアのためのテクニカルライティング - 「期限と優先度」
気まぐれに更新させてください
Discussion