😊

テキストコミュニケーション力を磨く、エンジニアのためのテクニカルライティング - 「期限と優先度」

2024/11/15に公開

現役エンジニアのたくみです

この記事は前回の続きとなります
テキストコミュニケーション力を磨く、エンジニアのためのテクニカルライティング - 「実用文と読者層」

お時間のある方は、一度読んでから本記事を読むと理解が深まると思います

この記事の対象者

  • わかりやすいドキュメントを書きたい
  • Chatツールのやり取りをスムーズに行いたい
  • 誤解のない指示やお願いをしたい

参考書籍

https://techbookfest.org/product/3t8AGqtB65jsPtPhx6m5fr?productVariantID=nW5a2tEzEFtzMFqnpSeyRx

具体例

件名:停電のお知らせ

日々の業務お疲れ様です
管理部の管理太郎です
2024年11月20日(水)21時より、当ビルは点検のため停電をいたします

全員20時半までには完全退社をお願いいたします

また、以下に該当する方々は、後述する業務を実施し、退社するようにお願いいたします
対象者

  • 20時以降の勤務をするかた
  • PCを扱う方

上記に当てはまる方は、退社前に以下業務をお願いいたします

  • 20時以降の勤務をするかた
    • Wi-Fiの電源を抜く
    • 冷蔵庫の電源を抜く
  • PCを扱う方
    • PCのシャットダウン

残っている方々で声を掛け合って上記の対応をお願いいたします
くれぐれも21時以降社内に残らないように注意をお願いいたします

以上、管理部からのお知らせでした


3.冒頭に期限を書く

基本的に冒頭に「期限」を書きます
今の所、冒頭には

  • 対象者
  • 期限
    を書くことになります

基本的に仕事は時間で回っています
ミニマムなタスクですら、時間を使ってこなしているはずです

なぜ必要か

特にエンジニアの現場では、プロジェクトを進めていく上で期限はとても重要な要素です

もし、「期限」がなかった場合どうなってしまうでしょう


日々の業務お疲れ様です
管理部の管理太郎です
2024年11月20日(水)21時より、当ビルは点検のため停電をいたします

全員完全退社をお願いいたします

また、以下に該当する方々は、後述する業務を実施し、退社するようにお願いいたします


相手に余計なことを考えさせない

いつまでに退社すればいいのかがわかりません
残業を予定している人は21時ギリギリまで残っているかもしれません

不要なコミュニケーションをなくす

人によっては
「いつまでに退社すればいいですか?」
と聞いてくれるかもしれません
しかし、それはお互いにコストになります
あらかじめ明記しておけば、このコミュニケーションは不要になります

自分の行動に基準を設けることができる

また、指示やお願いをした相手の行動が見えない自分も、コストになります
20時半に全員が退社している前提で、無事みんなが帰ったかを確認するのと
何時に帰ったかわからない状態で確認するのでは
全く条件が違いますし、無事業務が21時まで完了するかも保証できません

さらに、冒頭に期限を書くことで、上司や関係者に報告しやすくなります

4.優先度を書く

これは期限にも近いものがありますが、全く別です
期限が決まっていても、優先度は決まっていません

例えば、締め切りまで残り25日もあるが、依頼側のタスクの都合上、できるだけ早い方が助かる
というケース
この場合は、

「締め切りは⚪︎日までとなりますが、〇〇が終わっている方は最優先で対応お願いいたします」
となるわけです

まとめ

感想

この記事は「テクニカルライティング」ほんの一部の紹介です
しかし、たったこれだけで相手のネクストアクションを制限することができます

私は、「人によって捉え方が変わる」と言うことが本質的な問題だと思っています
あくまで5年営業していた私の考えですが、「読み手が思考しないと答えが出ない時点で誤解を生む」のではないかと思います
できるだけ「人による捉え方の違いをなくす」ことで誤解のない文章が完成していくのだと思います

5W1Hを意識したお願いや指示、報告をすることでより誤解の少ないテキストコミュニケーションをとっていけるのではないでしょうか

まだまだここには書ききれないほどテクニカルライティングにはたくさんの技術があります
私が読んだ本も、一部を抜粋したものに過ぎません

  • レビューのされ方とレビューの仕方
    もとても面白かったです
    もっと深く知りたい方はぜひ、ご自身でお手に取って読んでみてください

最後まで読んでくださりありがとうございました

Discussion