NEXTSCAPE blog

株式会社ネクストスケープの社員による会社公式ブログです。ネスケラボでは、社員が日頃どのようなことに興味をもっているのか、仕事を通してどのような面白いことに取り組んでいるのかなど、会社や技術に関する情報をマイペースに紹介しています。

MENU

書評『技術者のためのテクニカルライティング入門講座』

はじめに

コロナ禍になり、リモートワークが増えるにつれて言葉の重要さを痛感することが増えてきまして、書き方に関する書籍を幾つか読んでみました。
今回その中の一冊を紹介したいと思います。 

www.shoeisha.co.jp

皆さんもこういった本だけでなく、仕事の中で先輩や上司の方から文章の書き方についての指摘を受けたことがあるかもしれません。

例えばよく言われるのが「結論を先に書く」であったり、「箇条書きを(効果的に)使う」であったり、文章を書くにあたってのテクニックに関するものが挙げられます。
この本では「入門講座」だけあってそういったテクニックももちろんなのですが、さらにもう一歩踏み込んだ実際の仕事に使える実践的な内容についても触れられており、非常に参考になりました。
私自身の経験からも共感もしくは納得した内容について自身の経験も交えつつ幾つか紹介させてください。

 

障害報告書を書くにあたっての注意点

障害報告書。できれば皆さん書きたくないと思いますし、まだ書いたことが無い方もITの仕事に関わっているといるといつか書く時がくるかもしれません。
原因をわかりやすく書くというのはもちろんなのですが、その時に障害を起こした立場としては、そして、お客様の怒りを軽減できるのではという思いで言い訳めいた表現を「意識的」もしくは「無意識に」書いてしまうかもしれません。
そういった言い訳的な表現はできるだけ避けましょうということをこの本では書いてます。

よくテレビなどで謝罪会見を目にしますが、少しでもその言葉の中に言い訳めいた表現を見つけてしまうと「本当に反省してるの?」と思ったことがあるかと思います。障害報告書もこれと同じで、極力そういった言い訳は書かないように気を付けないといけないですね。

 

エモーショナルな表現を加える

内容を簡潔に。。といったところは提案書や仕様書でも同じことが言えます。
そして、メールの場合であっても相手が忙しい中でわざわざ目を通してくれているわけなので、やはり簡潔にかつわかりやすくというのは大事なのですが、それだけでは難しい部分も出てきます。

例えば、スケジュール延期を連絡したい場合、「スケジュールを延期します。申し訳ありません」という最低限の内容ではお客様が納得されない場合が出てきます。
お客様の性格にもよりますが、例えばそれまで色々と親身にお付き合いいただいた場合であったり、お客様が更にその上長の方に報告しなければならないといった、「経緯」「背景」がそこに存在します。
その場合は「お忙しい中色々とプロジェクトの推進にご協力いただきながらご期待に沿えず非常に心苦しく。。」といったエモーショナルな表現も必要になってきます。
こういった経緯、背景を踏まえて、であったり、その場の空気を読むことに関しては今流行りのChatGPTでもまだ難しいかと思います。
単なるテクニックにとどまらず皆さんの人間力が試される部分にもなりますが、そういったところについてもこの本では触れられています。

 

読み手を想定する

自分が書いた文書を「誰が読み」、「どのような目的」で使うのかを常に意識する必要があるということをこの本では一貫して書いているように感じました。

例えば簡単な例を挙げるとすると、ツールのマニュアル1つとっても、例えばシステム管理者であればインストールに関する部分を書く必要がありますが、ツールを利用するオペレータにとってはインストールは重要ではなく、ツールの操作に重きを置いて記述されている必要があり、むしろ不要な情報とすら言えます。
上で挙げた障害報告書を例に更に踏み込んで考えましょう。
私が担当したシステムで障害が発生し、お客様として普段直接やり取りしている担当者の方、Aさんに提出するとします。
そして、Aさんが読めばわかるであろうという想定の上で障害報告書を書いてしまうかもしれないのですが、実際はAさんは自分の上長の人たちに私が書いた障害報告書をそのまま見せるか、あるいはその障害報告書を参考に社内用に別途資料を作成するかもしれません。
そうなると私はAさんだけでなく、Aさんの上長、普段そのシステムにあまり関わっていないような人達に読んでもらうことを想定して書く必要があるわけです。

手前味噌ではありますが、我が社の社長が書いたブログにおいてもこの「読み手を意識する」ことの重要性について触れたエピソードがありますのでよろしければ以下の記事もご覧ください(以下URLの「感動を教えてくれた社員」の箇所です)。

blog.nextscape.net

 

英語翻訳ツールの利用

あとはちょっとした日本語の添削テクニックとしてここ2、3年海外の人たちと英語でのメールのやり取りをしていたときに私自身が学んだことをここで紹介させてください。

それほど英語に自信の無い私でも最近はDeepLといったツールがあるのでそれほど苦労することなく英語でのやり取りが行えます。
ただその時に気づいた点として、主語や目的語を日本語では省略しがちなのですが、そうすると英語に翻訳した時に意味が違ったり、通じなかったりといったことが出てきますのでそれを直すことでより良い日本語になる場合もあります。
例えばとあるツールの画面の説明として「このボタンを押すとCSVファイルが出力される」といった簡単な文章を書いたとします。
日本語としてはそれほどおかしくはないのですが、誰がボタンを押すのか、CSVファイルを出力するのは誰なのかといったことが省略されているので英語に翻訳する前にそれをちゃんと書いてあげる必要があります。

余談かつ時事ネタですが、芸人の「とにかく明るい安村さん」がイギリスの番組で大ウケしていたニュースを先日見つけて、私もYoutubeで観ました。
決め言葉の「安心してください。はいてますよ」で目的語であるパンツを言っていないので審査員がツッコミの意味か、補足の意味かはわかりませんが、「Pants!」と叫んでましたね。
コール&レスポンス的な感じになって非常によかったのですが、これも日本語は目的語を略しがちという一例になるのかなと思います。

 

AIの普及と言葉の重要性

先ほどChatGPTについて触れましたが、現時点においてChatGPTを利用する場合はChatGPTに対して丁寧に説明することが求められます。
先ほど挙げた主語、目的語を明らかにするということもそうですし、人間に説明するとき以上に言葉を尽くして説明することで的確な回答が得られます。
人間相手の場合でも同じというか、相手が感情を持っているわけなので、AIに対して話す以上にきちんと説明してあげる必要があるんじゃないかなと思います。
私がDeepLを通じてそれに気が付いたように、今後AIを使う場面が増えていく中で言葉を尽くすことの大事さに皆さんが改めて気づいてくれると嬉しいなと、本を読み、この記事を書きながら思った次第です。

 

最後に

上に挙げた内容以外にも、箇条書きの最後に「。」を付けるかどうかについてであったり、受動態と能動態の使い分けであったり等、細かいテクニック等も含めてその日から早速使えそうな内容が盛りだくさんでした。
内容的にも読みやすく、仕様書やプレゼンだけに限らず一般的な「文書」もしくは「文章」を書くにあたって非常に役立つ一冊です。
興味を持ってくれた方は是非読んでみてください。