Vietnamese
Englishテクニカルライティングの手法の紹介
ブリスウェルにて、コミュニケーションが言葉でもテキストでもよく行われる業務活動です。したがって、私たちがお互いに誤解したり、相手の言いたいことを理解できなかったり、自分の言いたいことを表現できなかったりすることが再三起こります。この問題を改善するために、私たちは一緒にテクニカルライティングの授業に参加しました。
では、テクニカルライティングとは何でしょうか。これは専門的な主題や技術的な情報を、特定の読者に向けて明確に伝える書き方です。より具体的に言えば、日常生活でよく見られる例としては、冷蔵庫や洗濯機などに添付されるユーザーマニュアルです。しかし、これらのマニュアルがよく家の隅に置かれて、無視されているでしょう。つまらないと感じられるため、そういう扱いに納得できますね。
私も、最初は同じ気持ちを持っていましたが、この授業に参加した後、自分のコミュニケーションスキルを向上させるいくつかの手法を身につけました。そのため、家の隅に置いて無視する前に、一緒にこれらの手法に目を通してみましょう。
①文書を読者に合わせて適合させる方法
人によって、持っている経験や知識が異なるので、同じの事情に対しての反応も異なります。
例えば、開発者がエラーの原因について、基本的なIT知識を持っていない人に、以下のように説明しました。
「ファイルパーミッションが755なので、このユーザーがフォルダを作成できない。」
その場合、基本的なIT知識を持っていない人は「755」は何か、なぜ「755」とフォルダを作成することに関係するか困ります。そのため、相手が理解しやすいように、次のように説明できます。
「システムのアクセス権について、ユーザーがフォルダーのオーナーである場合のみ、フォルダーの配下を作成できます。しかし、現在のユーザーがフォルダーのオーナーではないので、配下を作成できません。」
上記の文は、より長く解説されるが、基本的なIT知識を持っていない人さえエラーの原因を想像できます。
つまり、コミュニケーションを行う際には、相手がどの情報を持っているか、どの情報を持っていないか考慮し、適切な解説方法を選ばなければなりません。
②用語の一貫性を保つ方法
例：
設計書にて、ある画面の仕様が以下のように書かれています。
「システムは、フォルダー「upload_file_2024」に保存されているファイルを取得し、画面に表示する。ユーザーが新規ファイルをアップロードする場合は、アップロードしたファイルをディレクトリ「upload_file_2024」に保存する。」
上記の文章を読むと、フォルダー「upload_file_2024」とディレクトリ「upload_file_2024」が同じ場所なのか混乱するかもしれません。なぜなら、上記の文章が用語の一貫性を保てないというミスをしました。この仕様を以下のように修正してみましょうか。
「システムは、フォルダー「upload_file_2024」に保存されているファイルを取得し、画面に表示する。ユーザーが新規ファイルをアップロードする場合は、アップロードしたファイルもフォルダー「upload_file_2024」に保存する。」
上記の文章は「フォルダ」という一貫した用語を使用するので、読み手がファイルの取得先とファイルの保存先が同じの場所で、「upload_file_2024」だと理解できます。
つまり、情報を解説する時、使われる用語が一貫しているかどうか必ず確認する必要があります。用語の一貫性を保つことは読み手が情報をもっと理解できるのに役に立つだけではなく、情報の信頼性をより高めます。
③不要な言葉を削除する方法
話す時、感情を表す言葉や類義語をよく使いますか。日常会話では感情を表現することが話をより生き生きとさせますが、議論や問題を話し合う場面では自分の意見を簡潔に伝える必要があります。
例えば、
「バグの修正は本当にとても遅く、時間がかかったため、お客さんに多くの損害を与えました。」
という代わりに、
「バグの修正は時間がかかったため、お客さんに多くの損害を与えました。」
というだけでも十分です。
「本当にとても遅く」という表現を言わなくても、相手はバグの修正に時間がかかったことを理解できるでしょう。簡潔な表現により、文章が分かりやすくなり、相手も話の要点を把握しやすくなります。
これまでに、私は役に立つと思うテクニカルライティングの3つの方法を紹介しました。読み終えた後、テクニカルライティングについてもっと知りたくなりますか。興味を持ったら、ブリスウェルの作成した資料を以下のリンクでご覧ください！
Training Technical Writing – ブリスウェルベトナム – Speaker Deck
参考元：