マニュアルライティングで心がけるべきこと

2025年3月7日2025年3月18日

通算第50号

“Not to be obsessed with correctness”(正確さにとらわれすぎない)

　マニュアルなどの説明文を書いているときに、わたしは、“Not to be obsessed with correctness”(正確さにとらわれすぎない)ということを意識します。もちろん、正確に書くということは、人に情報を適切に伝達するための基本的な約束事です。“Correctness”、つまり“Quality”は、効果的なコミュニケーションを実現するためのGricean maxims—the cooperative principle*の原則の１つにもなっています。正確に書かなければ、人は適切に理解したり、行動したりしてくれないわけですから。
　しかし、正確さを意識しすぎるあまりに、説明の内容がわかりにくくなったりすることがあります。そこで、その「わかりにくくなる」例をChatGPTに挙げてもらうことにします。はたして、どういった種類のわかりにくさがあるでしょうか。興味深いところです。

「わかりにくくなる」理由で考えられること

中村が考える範囲では、その理由として以下のようなことが考えられます。
　①数値や説明などが詳細すぎる
　②内容が複雑でわかりにくい
　③論理がわかりにくい
　④内容が専門的な知識を必要とする
　⑤表現がわかりにくい
　⑥製品のUI自体に問題がある

ChatGPTに、上記の内容を英語で尋ねてみることにしました。

ChatGPTへの質問

中村：
When writing instructions for manuals and similar materials, I try to avoid “being overly obsessed with correctness.” Of course, writing correctly is a fundamental rule for properly conveying information to readers. “Correctness” is also one of the principles of Grice’s maxims* under the Cooperative Principle* for achieving effective communication. If you do not write correctly, people may misunderstand or fail to act appropriately.
However, “being too focused on correctness” can sometimes make explanations harder to understand. I will ask ChatGPT to provide examples. What kinds of difficulties might arise? It is quite interesting.
（「マニュアルや類似の資料の指示を書く際、私は『過度な正しさへのこだわり』を避けるようにしています。もちろん、正しく書くことは、読者に情報を適切に伝えるための基本的なルールです。『正しさ』は、効果的なコミュニケーションを達成するための協調原理(*1)に基づくグライスの公理(*2)の一つでもあります。正しく書かなければ、人々は誤解したり、適切に行動できなかったりする可能性があります。しかし、『正しさに過度に焦点を当てること』は、説明を理解しにくくすることがあります。ChatGPTに例を挙げてもらおうと思います。どのような困難が生じる可能性があるのでしょうか？非常に興味深いです。」）

(*1):協調原理：コミュニケーションにおいて、参加者が互いに協力し、円滑な情報伝達を目指すという原則。
(*2):グライスの公理：ポール・グライスによって提唱された、効果的なコミュニケーションのための四つの原則（質の公理、量の公理、関連性の公理、様式の公理）。

ChatGPTの回答

ChatGPT：
Let me address your questions properly.
You asked about the difficulties that arise from being too conscious of correctness when writing instructions or manuals. Here are some examples of the challenges:（ご質問に適切にお答えします。
説明書やマニュアルを書くときに正確さを意識しすぎると困難が生じるというご質問がありました。その課題の例をいくつか挙げます。）

１．Overly Complex Sentences（複雑すぎる文を書いてしまう）
わかりにくさの種類：上記②に該当(以降、数字のみ表記)
When trying to ensure grammatical perfection or technical precision, sentences may become overly complex. This can confuse readers rather than help them.（文法的にとか技術的にとか、または、わかりきったこととなど、詳細を書き加えてしまい複雑になりすぎてしまう。）
・Example (Too Correct):
“Ensure that the power supply cable is inserted into the designated port of the device, taking into account the orientation of the connector, which must align with the port configuration.”
・Simpler Version:
“Insert the power cable into the port. Make sure the connector is aligned properly.”
前者は、わかりきったことを、文法的な尾ひれまでつけて、むだに文を長くしています。Minimalism writingを心がけることで、簡潔な説明文が書けます。

２．Using Unnecessary Jargon or Formal Language（不必要な専門用語や堅苦しい言葉を使う）
わかりにくさの種類：④
Excessive correctness can lead to the use of formal, technical, or academic language that the average reader may not understand.（正確さを追求するあまり、読者に馴染みのない、フォーマルで、技術的で、アカデミックな表現を使ってしまう。）
・Example (Too Correct):
“Depress the lever to commence the process.”
・Simpler Version:
“Press the lever to start.”
前者は、むだに「高尚さ」を意識しているようです。これも、やりがちですね

３．Loss of Natural Tone（自然な表現をしなくなりがち）
わかりにくさの種類：⑤
Trying to adhere strictly to formal correctness can make instructions sound stiff and unnatural, making them harder to follow.（形式的な正確さに厳密に従おうとすると、指示が堅苦しく不自然になる。）
・Example (Too Correct):
“The operator is advised to proceed with caution when engaging the device.”
・Simpler Version:
“Be careful when using the device.”
前者はなんと古臭い表現でしょうか。(年配の)英語ネイティブ翻訳者が使いがちです。あなたの会社の英文ドキュメントに、このような堅苦しい古臭い表現が残っていたりしませんか。

４．Unnecessary Details（不必要な詳細を加えてしまう）
わかりにくさの種類：①
In an effort to be perfectly correct, writers might include too much information, which overwhelms readers.（正確に完全に書こうと思うのか、読者を困惑させるような不要な情報を含めてしまう。）
・Example (Too Correct):
“This button, which is circular and located on the left side of the panel, must be pressed gently for approximately two seconds to activate the system.”
・Simpler Version:
“Press the circular button on the left for two seconds to activate the system.”
このような、不要な詳細を含めていませんか。Minimalism writingを心がけることで、簡潔な説明文が書けます。

５．Ignoring Audience Needs（読者の知りたい情報を無視する）
わかりにくさの種類：？
Focusing too much on correctness might mean ignoring the reader’s knowledge level or context. Readers might only need clear and practical instructions, not textbook-perfect sentences.（正確さに重点を置きすぎて、読者の知識レベルや状況を無視していませんか。読者が必要としているのは、明確で実用的な指示だけです。）

ChatGPTのWeb検索で実例と共に確認してみる

ChatGPTのウェブ検索機能を使って、なぜ説明が難しくなるのかということとその実例を、確認してみます。

中村：
ウェブ検索: Reasons why explanations are difficult to understand and their examples(なぜ説明が難しくなるかということと、その実例)

ChatGPT：
Explanations can be difficult to understand for various reasons, often leading to confusion or misinterpretation. Here are some common challenges along with examples:（説明はさまざまな理由で理解しにくい場合があり、混乱や誤解を招くことがよくあります。以下に、よくある課題とその例を示します。）

１．　Use of Complex Language: （難解な表現や用語、そして複雑な文構造を使ってしまう）
わかりにくさの種類：②、④
Employing technical jargon, advanced vocabulary, or convoluted sentence structures can make explanations hard to follow.
・Example: “The apparatus utilizes a pneumatically actuated mechanism to facilitate the transference of materials.”
・Simpler Version: “The device uses air pressure to move materials.”
前者をよく読んでください。思わず吹き出してしまいますね。前者は、(いささか誇張されてはいますが) ISOを代表とするアカデミー系の文ですね。ISO House StyleというISOを書くためのライティングガイドがあります。それに従うと、このような文になるのかもしれません、というか、なります。いずれにしても、このように、できる限り難解で洗練された文を書く人たちがいます。しかし、よく考えてください。せっかく書いて発表するのであれば、より多くの人たちに理解してほしいですよね。
それに対して、後者は、簡潔でわかりやすいビジネス文です。はたして、どちらがいいのでしょうか？
と言っても、これは、「正確さ」とは関係ありませんので、今回のテーマとは少し外れています。

２．Lack of Structure: （論理的な順序を無視する）
わかりにくさの種類：➂
Presenting information in a disorganized manner without a clear sequence can confuse the audience.
・Example: “To assemble the shelf, insert the dowels after attaching the side panels, but first, ensure the top panel is aligned.”
・Improved Version:
　1.Align the top panel.
　2.Attach the side panels.
　3.Insert the dowels.
説明文にはすべて適切な順序があります。ただし、これは、今回のテーマである「正確さ」と矛盾しますので、無視します。

３．Assuming Prior Knowledge: （読者の知識レベルを考慮しない）
わかりにくさの種類：④
Overlooking the audience’s familiarity with the subject can lead to misunderstandings.
・Example: “Apply the Gaussian blur to the image to achieve the desired effect.”
・Clarified Version: “In your photo editing software, select ‘Gaussian blur’ from the filter menu to soften the image edges.”
読者の知識レベルを考慮して、その読者に合った説明する必要があります。

４．Overloading with Information: （(専門的な)情報を詰めすぎる）
わかりにくさの種類：④
Providing too much information at once can overwhelm readers or listeners.
・Example: “The human respiratory system, comprising the nasal cavity, pharynx, larynx, trachea, bronchi, and lungs, functions to exchange oxygen and carbon dioxide, which is vital for cellular respiration and energy production.”
・Concise Version: “The respiratory system helps us breathe by exchanging oxygen and carbon dioxide.”
いくら正確であっても、一度に過度の量の(専門的な)情報を示すと、読者は困惑してしまいます。

５．Lack of Examples or Analogies: （適切な例や譬えを使わない）
わかりにくさの種類：④
Failing to use relatable examples can make abstract concepts harder to grasp.
・Example: “Photosynthesis is the process by which plants convert light energy into chemical energy.”
・With Analogy: “Photosynthesis is like a plant making its own food using sunlight.”
読者の既存の知識レベルにあった例や譬えを使ってわかりやすく説明します。ただし、今回のテーマである「正確さ」とは関係ありません。

６．Ambiguity: （曖昧さ）
わかりにくさの種類：⑤
Using vague terms or not specifying details can lead to multiple interpretations.
・Example: “Place the item near the tool.”
・Specific Version: “Place the item within arm’s reach to the right of the hammer on the workbench.”
曖昧性を排除して、具体的に説明します。「曖昧さ」があるということは「正確」ではないということも意味します。ですので、今回のテーマである「正確さ」とは少し異なります。

７．Cultural Differences: （異文化理解の必要性）
わかりにくさの種類：？
Not considering cultural contexts can result in misinterpretation.
・Example: Using idioms or references specific to one culture that others may not understand.
・Considerate Version: Using universally understood terms or providing explanations for culturally specific references.
異文化理解は、わかりやすい説明には必要ですが、今回のテーマとは関係ありません。

By being mindful of these potential pitfalls and tailoring explanations to the audience’s needs, communicators can enhance clarity and comprehension.（こうした潜在的な落とし穴に注意し、聴衆のニーズに合わせて説明を調整することで、コミュニケーション担当者は明瞭性と理解を高めることができます。）

ところで、情報源が明示されていないので、Do you not indicate the source cited?と尋ねようと思いましたが、ChatGPTのメッセージの最後に「情報源」とありましたので、そこをクリックしてみました。

すると、画面の右側に新たにペインが追加表示され、そこになんと「情報源」が明示されているではありませんか。びっくりです。ここまで丁寧な仕事をされるとは、ただただ、恐縮するばかりです。ただし、どの情報源がどれのことなのかがわかりませんが。

「情報源」と一括りになっているだけで、どれがどれの情報源なのかがわかりません。そこで、以下の質問をしてみました。

中村：
You have shown me the results of a web search, and you show me those “sources,” but you do not tell me which source is which.（あなたは私にウェブ検索の結果を見せ、それらの「ソース」を示してくれましたが、どのソースがどれであるかは教えてくれませんでした。）

ChatGPT:
Apologies for any confusion caused by my previous responses. When I provide information, I aim to integrate knowledge from various sources to offer a comprehensive answer. In this instance, the explanations regarding why certain explanations can be difficult to understand are based on general principles of effective communication and common challenges encountered in instructional writing.
If you have specific questions or need further clarification on any of the points discussed, please feel free to ask.
（回答で混乱を招いた場合はお詫び申し上げます。情報を提供する際は、さまざまな情報源からの知識を統合して包括的な回答を提供することを目指しています。この場合、特定の説明が理解しにくい理由に関する説明は、効果的なコミュニケーションの一般原則と、指導文書で遭遇する一般的な課題に基づいています。
具体的な質問がある場合や、議論された点についてさらに説明が必要な場合は、遠慮なくお問い合わせください。）

このように、ざっくりとした説明になっています。ということは、ChatGPTでウェブ検索ができるようにはなりましたが、引用を示してくれるわけではありません。ChatGPTは、Googleのように、単に検索先を表示してくれるだけではなく、ChatGPTとしてその内容をまとめてくれるわけですので、残念ですね。そこができれば、言うことはないのですが。

残った課題への質問

ところで、わかりにくさの種類のうち、「⑥製品のＵＩ自体に問題がある」に該当するものが無かったので、ChatGPTに例文をつくってもらいます。

中村：
You gave me a variety of examples, but for example, the operation method of the product’s UI itself is difficult to understand, so even if you try to operate it according to the UI, it is impossible to operate. Can you give us an example like that?
（いろいろな例をあげていただいたのですが、例えば、製品のUIの操作方法自体がわかりにくくて、UI通りに操作しようと思っても操作できない、といったような例を挙げていただけますか？）

これは難しいかな？

ChatGPT:
１．Overlapping Elements: （文字がUIと重なる）
When interactive elements overlap with content, it can obstruct functionality and confuse users.
・Example: In some applications, a “+” icon might overlap with text or other buttons, making it difficult for users to read content or access functions properly.
[引用元（注：リンク割愛）]

２．Overloaded Search Results Display: （検索結果が多すぎる）
Presenting search results in an intrusive or cluttered manner can disrupt the user experience.
・Example: An application that displays search results as an overlay without proper context or organization can confuse users, making it hard to find the desired information.
[引用元（注：リンク割愛）]

３．Non-clickable Footer Links: （クリックできない項目リスト）
Displaying a list of items that appear interactive but are not clickable can mislead users.
・Example: A website footer listing numerous city names that seem like navigation links but are actually plain text can frustrate users trying to interact with them.
[引用元（注：リンク割愛）]

４．Confusing Forms: （指示が不適切なサイト）
Forms that lack clear guidance or have poor error handling can impede user progress.
・Example: A form that doesn’t indicate which fields are mandatory or fails to provide helpful error messages when users make mistakes can lead to user frustration and abandonment.
[引用元（注：リンク割愛）]

５．Poor Touch Targets on Mobile: （モバイルのタッチターゲットの小ささ）
Interactive elements that are too small or placed too closely together can be difficult to tap accurately on touch devices.
・Example: Buttons or links that don’t adhere to recommended touch target sizes can cause users to tap the wrong element, leading to navigation errors and frustration.
[引用元（注：リンク割愛）]

These examples illustrate how certain UI design flaws can make it challenging for users to operate a product as intended. Addressing such issues involves adhering to usability principles, conducting thorough user testing, and iterating on design based on user feedback to ensure a seamless and intuitive user experience.（これらの例は、特定の UI 設計上の欠陥により、ユーザーが製品を意図したとおりに操作することが困難になる可能性があることを示しています。このような問題に対処するには、ユーザビリティの原則を遵守し、徹底したユーザーテストを実施し、ユーザーからのフィードバックに基づいて設計を繰り返し、シームレスで直感的なユーザーエクスペリエンスを確保する必要があります。）

カバーする範囲が、ちょっと広がりすぎましたが、いろいろと出てくるものですね。
しかも、ChatGPTは特定の引用元は表示しないと言っていたのですが、それぞれの項目の最後に、「引用元」がしっかりと表示されています。驚きです。これなら、まったく問題ありません。
そこで、特定の引用元を表示できるのか？それとも、特定の引用元を表示できるときとできないときがあるのか？—ということをChatGPTに聞いてみました。

中村：
You said, “When providing information, you aim to integrate knowledge from various sources to provide comprehensive answers.” Is it possible to display a specific source like this? Or are there times when you can display a specific source and times when you cannot?（「情報提供にあたっては、さまざまな情報源からの知識を統合し、包括的な回答を提供することを目指します」とおっしゃっていますが、このように特定の情報源を表示することは可能でしょうか。それとも、特定の情報源を表示できる場合とできない場合があるのでしょうか。）

ChatGPT:
ご質問ありがとうございます。
私の主な機能は、学習した知識を基にユーザーの質問に回答することです。しかし、特定の情報源を明示的に参照することは通常の機能には含まれていません。ただし、特定の状況や設定によっては、引用元を表示することが可能な場合もあります。例えば、ChatGPTのブラウジング機能やプラグインを活用することで、文献を基にした考察を行う際に引用元を明示することができます。
ボチェク[注：リンク割愛]
また、ChatGPTの回答に参照元を表示させる機能が追加され、情報の信頼性を向上させる取り組みも進められています。
Anybot[注：リンク割愛]
さらに、ChatGPTの新機能「ChatGPT Search」を利用することで、最新のウェブ情報を基にした回答を提供し、引用元リンクを提示することが可能です。
AI総研[注：リンク割愛]
これらの機能や設定を活用することで、特定の引用元を表示することが可能となります。しかし、すべての状況で引用元を表示できるわけではないため、必要に応じてこれらの機能を適切に設定・利用することが重要です。
ご不明な点がございましたら、遠慮なくお知らせください。

なるほど、アプリの設定によっては、引用元を表示させることができるのですね。これでしたら、ChatGPTは強力なツールになりますね。

まとめ

　今回の、“Not to be obsessed with correctness”というテーマは、わたしが出版した“Writing Clear and Concise Manuals”という英文書籍で説明している項目の一つです。この“Writing Clear and Concise Manuals”は、英文マニュアルをわかりやすく、簡潔に書くということを追求しているものであり、マニュアルを書くために必要なすべての情報がそろっています。Minimalism writingやテクニカルライティングだけではなく、ライティングの周辺技術であるGestalt principlesなどについても説明しています。また、それぞれの例文も多数ありますので、一冊お手元に置いて活用していただければと思います。
　アマゾンで“Writing Clear and Concise Manuals”と検索していただくか、こちらをクリックしていただければ、ご覧になれます。