Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
テクニカルライティングトレーニング - ブリスウェルベトナム
Search
Briswell Vietnam
April 08, 2024
Education
1
67
テクニカルライティングトレーニング - ブリスウェルベトナム
GoogleのTechnical Writing Coursesを元にブリスウェルベトナムが作成したトレーニング用の資料
Briswell Vietnam
April 08, 2024
Tweet
Share
More Decks by Briswell Vietnam
See All by Briswell Vietnam
Training Technical Writing - Công ty Briswell Việt Nam
bwv
0
77
Other Decks in Education
See All in Education
1113
cbtlibrary
0
280
2024年度秋学期 統計学 第2回 統計資料の収集と読み方(授業前配付用) (2024. 10. 2)
akiraasano
PRO
0
100
Repaso electricidade e electrónica
irocho
0
210
Design Guidelines and Models - Lecture 5 - Human-Computer Interaction (1023841ANR)
signer
PRO
0
720
Future Trends and Review - Lecture 12 - Web Technologies (1019888BNR)
signer
PRO
0
2.5k
LLMs for Social Simulation: Progress, Opportunities and Challenges
wingnus
1
130
自己紹介 / who-am-i
yasulab
PRO
2
4.3k
Semantic Web and Web 3.0 - Lecture 9 - Web Technologies (1019888BNR)
signer
PRO
2
2.6k
ニュースメディアにおける生成 AI の活用と開発 / UTokyo Lecture Business Introduction
upura
0
150
Mathematics used in cryptography around us
herumi
2
400
1216
cbtlibrary
0
250
Comezando coas redes
irocho
0
400
Featured
See All Featured
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
29
910
RailsConf 2023
tenderlove
29
940
Templates, Plugins, & Blocks: Oh My! Creating the theme that thinks of everything
marktimemedia
28
2.1k
The Web Performance Landscape in 2024 [PerfNow 2024]
tammyeverts
2
290
Typedesign – Prime Four
hannesfritz
40
2.4k
How STYLIGHT went responsive
nonsquared
96
5.2k
Building an army of robots
kneath
302
44k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
248
1.3M
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
95
17k
Agile that works and the tools we love
rasmusluckow
328
21k
Building Adaptive Systems
keathley
38
2.3k
Making the Leap to Tech Lead
cromwellryan
133
9k
Transcript
テクニカルライティング トレーニング Briswell Vietnam Co. Ltd, 2024/03/20
テクニカルライティングとは 専門的な情報の伝達: 専門的な主題や技術的な情報を、特定の読者に向けて明確かつ正確に伝える 書き方。 読者中心のアプローチ: 読者の必要と理解レベルに基づいて情報を提供。
テクニカルライティングの活用 テクニカルライティングはソフトウェア開発だけでなく、あらゆる分野で用いること ができ、効果を発揮できる。 • ユーザーマニュアル • 操作マニュアル • 分析レポート •
ビジネスプラン • QA • etc
トレーニング: 用語の一貫性を保つ
Why? テクニカルライティングにおける用語の不一致は、読者の混乱を招き、文書の 信頼性を損ないます。不明確な表現は理解の妨げになり、正確な情報伝達を 阻害する可能性があります。 What? 用語の一貫性を保つことで、読者は各用語が指す概念を正確に把握でき、文 書の意図を明確に理解することができます。 How? 最初に用語を定義し、文書全体を通じてその用語を一貫して使用します。用語リ ストやスタイルガイドを活用して一貫性を保つことも有効です。
悪い例 文書中で「サーバー」と「サーバ」という用語を交互に使用している。 良い例 文書の初めに「サーバー」という用語を定義し、文書全体で一貫して使用してい る。 悪い例では用語が不一致で読者が混乱する可能性がありますが、良い例では用語 が一貫して使用されているため、文書の意図が明確で理解しやすくなっています。
上記文書中で2つの用語が混在して使用されています。 その用語を見つけてください。 また、一貫性を持たせるためにはどのように修正すればよい ですか? トレーニングしましょう!! 「 新 プロジェクトでは、クライアントとの 円 滑
なコミュニケー ションを通じて、顧客のニーズに応えます。我々のチームは 顧客と協力し、フィードバックを活かしてサービス向上を図り ます。」
トレーニングしましょう!! 正解 「クライアント」と「顧客」という用語が混在して使用されています。 文書の初めで「クライアント」という用語を「顧客」として定義し、その後は文書全体で「顧客」 という用語を一貫して使用すべきです。 用語の一貫性を保つためには、文書内で最初に用語の定義を行い、その定義に基づいて文書全体 で一貫してその用語を使用する必要があります。これにより、用語の混乱を避けることができます。 「新プロジェクトでは、 顧客との円滑なコミュニケーションを通じて、 顧客のニーズに応え
ます。我々のチームは 顧 客と協 力し、フィードバックを活かしてサービス向 上を図りま す。」
トレーニング: あいまいな代名詞の使用 を回避する
Why? あいまいな代名詞は読者が文脈を誤解する原因となり、特に複数の対象が絡 む場合には、どの対象を指しているのかが不明確になりがちです。 What? 代名詞を使用する際には、その参照先が明確になるように注意し、あいまいさ が生じないようにする必要があります。 How? 代名詞を使用する前に、明確に参照先を指し示す名詞を用いるか、必要であれ ば代名詞ではなく名詞を繰り返すことであいまいさを避けます。
悪い例 「彼がボタンを押した後、彼はメッセージを表示した。」 良い例 「ユーザーがボタンを押した後、システムはメッセージを表示した。」 悪い例では「彼」という代名詞が 2回使われていますが、それがユーザーを指している のか、それとも別の人物またはシステムを指しているのかが不明確です。良い例で は、代名詞を使わずにそれぞれ「ユーザー」と「システム」という具体的な名詞を使用 することで、誰が何をしたのかが明確になっています。
「開発者がコードを修正した後、彼はテストを実行したが、エ ラーが発生した。」という文において、あいまいな代名詞を明 確にしてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「開発者がコードを修正した後、 彼はテストを実行したが、エラーが発生した。」 代名詞「彼」が誰を指しているのかを明確にするためには、代名詞を避け、行動の主体を明確に示す 名詞「開発者」と結果の主体を示す名詞「システム」を使用することが有効です。これにより、どの行動 が誰によってなされ、どの結果が何によって引き起こされたのかが明らかになります。 ※主語などの名詞を書かないというのも同様にわかりにくいため書くように注意をすること 「開 発
者がコードを修 正した後、開 発 者はテストを実 行したが、システムがエ ラーを表示した。」
トレーニング: 受動態よりも能動態を利用 する
Why? 受動態はしばしば誰が行動を起こしたのか不明確にしてしまい、文章を冗長に し理解を難しくします。一方、能動態は行動の主体を明確にし、文章を簡潔でダ イナミックにします。 What? 文章を書く際は、受動態を使うよりも能動態を使うことを心掛け、文の主体が行 動を起こしていることをはっきりと示します。 How? 文を構成する際に、行動の主体を文の前半に置き、その主体が行った行動を述 べることで能動態の使用を優先します。
悪い例 「レポートはエンジニアによって書かれました。」 良い例 「エンジニアがレポートを書きました。」 悪い例では、受動態によって文が冗長になり、誰がレポートを書いたのかが不明確で す。良い例では、能動態を使ってエンジニアが行動の主体であることを明確にし、文 がより簡潔でわかりやすくなっています。
「プロジェクトがチームによって完了された。」 上記を能動態に書き換えてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「プロジェクトがチームによって完了された。」 受動態を能動態に書き換える際には、行動を起こした主体を文の前面に出し、その主体がどのような 行動を行ったかを述べる形にします。これにより文はより直接的で、行動の責任を明確にすることが できます。 ✖ バリデーションチェック後にエラーが表示された。 ⭕(プログラムが)バリデーションチェック後にエラーを表示する。 「チームがプロジェクトを完了させた。」
トレーニング: あいまいな動詞より具体的 な動詞を選択する
Why? 具体的な動詞を使用することで、行動やプロセスが明確に伝わり、読者の理解 を助けます。あいまいな動詞は情報を曖昧にし、文の意図を不明瞭にすること があります。 What? 文を書く際には、動作や状態を正確に表現する具体的な動詞を選び、読者が 正確なイメージや理解をできるようにする。 How? 動詞を選ぶ際には、行動を具体的に示すものや、より詳細な情報を提供するも のを選びます。可能な限り一般的な動詞を避け、行動の性質や結果を明確に示
す言葉を使用します。
悪い例 「マネージャーはプロジェクトを進める。」 良い例 「マネージャーはプロジェクトを計画し、実行し、監視する。」 悪い例では「進める」という動詞が何を具体的に指しているのか不明確です。良い例 では「計画し」「実行し」「監視する」という動詞が具体的な行動を示しており、マネー ジャーの行っている具体的なアクションが明らかになっています。
「エンジニアはシステムをチェックする」 上記をより具体的な動詞を使用して書き換えてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「エンジニアはシステムをチェックする。」 より具体的な動詞に書き換えることで、エンジニアがどのようなチェックを行うのか、ど んな基準で評価をするのかが明確になります。これにより、読者はエンジニアの行動 やその目的をより正確に理解できるようになります。 「エンジニアはシステムの機能をテストし、パフォーマンスを 評価する。」
トレーニング: 各文を単一のアイデアに 集中する
Why? 一つの文に一つのアイデアを持たせることで、内容が明確になり、読者が情報 を簡単に消化し理解することができます。複数のアイデアが一つの文に含まれ ると、混乱を招き、メッセージが不明瞭になる可能性があります。 What? 文章を書く際には、各文を一つの主要なアイデア、ポイント、または概念に限定 し、その文が伝えるべき中心的なメッセージを明確にします。 How? 文を構成する際には、関連する情報を分割し、独立した文に展開します。一文が 長くなりすぎたり、複数のアイデアが絡み合っている場合は、それらを分けて複
数の文に分解することで、各文の目的と情報を明確にします。
悪い例 「プログラムはエラーを修正し、効率を向上させ、ユーザビリティを高めるために アップデートされました。」 良い例 「プログラムはエラーを修正するためにアップデートされました。さらに、このアッ プデートにより効率が向上しました。また、ユーザビリティも高まりました。」 悪い例では、一つの文に複数のアイデアが詰め込まれており、各アイデアが独立して いないため、文が読みにくくなっています。良い例では、それぞれのアイデアが独立し た文として表現されているため、各ポイントが明確で、読者は各アイデアを容易に理 解できます。
「サーバーは容量を増やすためにアップグレードされ、セキュ リティも強化され、メンテナンスの手間が減りました。」 上記を各アイデアを独立した文に分けてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「サーバーは容量を増やすためにアップグレードされ、セキュリティも強化され、メンテナンスの手間 が減りました。」 一文に複数のアイデアが含まれている場合は、それぞれのアイデアを個別の文に分 割することで、情報が整理され、各ポイントがはっきりとします。これにより、読者は各 文の主要なメッセージを簡単に把握できるようになります。 「サーバーは容量を増やすためにアップグレードされました。セキュリティも強化され ました。さらに、メンテナンスの手間が減りました。」
トレーニング: 長文を箇条書きに変換する
Why? 長文は読み手にとって消化しづらく、特に複雑な内容や多くの要素を含む場 合、重要な点を見落とす原因となります。 What? 情報を箇条書きに変換することで、内容を簡潔にし、各ポイントを際立たせるこ とができます。 How? 長文を箇条書きに変換する際には、主要な点をリストアップし、それぞれを独立 した行に配置します。これにより、読み手は情報を素早くスキャンし、理解するこ とが可能になります。
悪い例 「私たちのシステムには、効率的な検索機能、ユーザーフレンドリーなインターフェイス、高度なセ キュリティ対策、簡単なナビゲーション、多様なカスタマイズオプションが備わっており、業務の生産 性を大幅に向上させることができます。」 良い例 私たちのシステムは以下の特長を備えています: • 効率的な検索機能 • ユーザーフレンドリーなインターフェイス
• 高度なセキュリティ対策 • 簡単なナビゲーション • 多様なカスタマイズオプション 悪い例では一つの文に多くの情報が詰め込まれており、重要な特長を見落としやすいです。良い例で は、箇条書きにより各特長が明確に分離され、読み手が個々の機能をすばやく把握できます。
「弊社のサービスは顧客満足度を向上させるために、迅速な 顧客対応、詳細なフィードバック分析、パーソナライズされた サービス提 供、そして定 期 的な品 質チェックを行っていま す。」 上記をリスト形式に変換してください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 弊社のサービスは顧客満足度を向上させるために、迅速な顧客対応、詳細なフィードバック分析、 パーソナライズされたサービス提供、そして定期的な品質チェックを行っています。 情報を箇条書きに変換することで、サービスの特徴や提供する価値を一目で明確にし、読み手が情 報を迅速に理解しやすくなります。 弊社のサービスが顧客満足度を向上させるために行っていること: • 迅速な顧客対応 •
詳細なフィードバック分析 • パーソナライズされたサービス提供 • 定期的な品質チェック
トレーニング: 不要な言葉を削除する
Why? 余分な言葉は文章を冗長にし、読者の理解を妨げる。情報の本質を伝えるべき 部分が不要な言葉に埋もれてしまうことがあります。 What? テクニカルライティングでは、必要最小限の言葉を用いて、簡潔に情報を伝える ことが求められます。これにより、文章の明快さと理解の容易さが向上します。 How? 冗長な表現を避け、同義の言葉の重複や明らかに情報価値のないフィラーワー ド(つなぎ言葉(間投詞・冗長語))を削除します。また、強調のために不必要に言 葉を重ねることなく、ポイントを簡潔に述べます。
悪い例 「全く新しい革新的な方法を使用します。」 良い例 「革新的な方法を使用します。」 「全く新しい」と「革新的」は意味が重複しており、どちらも新しさを表しているため、一方を省いても意 味が変わりません。より簡潔にすることで文章が強化されます。
「開発者は、本当に頻繁に、コードをチェックして、なるべく早く バグを見つけるようにしています。」 上記から不要な言葉を省いてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「開発者は、本当に頻繁に、コードをチェックして、なるべく早くバグを見つけるように しています。」 「本当に」と「なるべく」は強調のために用いられていますが、これらは冗長であり、「頻繁に」と「早期 に」だけで意図は明確です。不要な言葉を削除することで、文はより簡潔で直接的なメッセージを伝え ることができます。 「開発者は頻繁にコードをチェックして早期にバグを見つけます。」
トレーニング: 番号付きリストと箇条書きリス トを使い分ける
Why? 文書内でプロセスのステップや優先順位を示す必要がある場合、情報の順序が混乱することな く、読者が手順を追いやすくなります。一方で、順序が特に重要でない場合には、箇条書きを用 いることで、情報を等価でアクセスしやすい形式で提供できます。 What? 番号付きリストは、手順、段階、優先順位が強調されるべき内容に用います。箇条書きリスト は、項目間の順序や優先順位を問わない情報の提示に適しています。 How? 手順書やプロセスの説明で各ステップの順番を明確にするために番号付きリストを使用します。 一方で、一覧性を要するが順序が不要な場合、例えば機能一覧やオプションの提示には箇条書
きリストを使用します。
悪い例 トラブルシューティングのステップを箇条書きで示す。 良い例 トラブルシューティングの手順を 1から始まる番号付きリストで示す。 トラブルシューティングの手順には特定の順序で行う必要があるため、番号付きリストを用いること で、読者は次に何をすべきかを容易に理解できます。一方で、順序が関係ない情報の提示には箇条 書きを用いることで、読者が各項目を自由にアクセスできます。
「アカウントを作成するには、名前を入力し、メールアドレスを 入力し、パスワードを設定し、利用規約に同意します。」 上記を適切なリスト形式で整理してください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「アカウントを作成するには、名前を入力し、メールアドレスを入力し、パスワードを設定し、利用 規約に同意します。」 この情報はアカウント作成の手順を示しているため、各ステップは順序立てて行われるべきです。そのため、 番号付きリストを使用して手順を明確にし、読者がそれぞれのステップを順番に追うことができるようにしま す。 アカウント作成の手順: 1. 名前を入力する。
2. メールアドレスを入力する。 3. パスワードを設定する。 4. 利用規約に同意する。
トレーニング: リスト項目の文法を統一する
Why? リスト内の項目が文法的に一貫していないと、読者が情報を整理し理解する際に混乱を招きま す。並列性を保つことで、リストの各項目が同じ文脈で書かれていることが明確になり、読みや すさが向上します。 What? リスト作成時には、すべての項目が同じ形式(名詞、動詞、完全な文など)であることを確認し、 一貫性を持たせます。これにより、リスト全体としての一貫性と整合性が保たれます。 How? リストの各項目を作成する際は、最初の項目を参照として、残りの項目も同じ文法構造を維持す るようにします。項目が文の断片であれば全て断片で、完全な文であれば全て完全な文である
べきです。
悪い例 リスト内で文の形式が混在している: • プロジェクトの計画を立てる • 実行中のタスクを監視 • プロジェクト完了後のレビューを行います 良い例 リストの項目が全て同じ文形式で統一されている:
• プロジェクトの計画を立てる • 実行中のタスクを監視する • プロジェクト完了後のレビューを行う 悪い例では、リストの項目が異なる文形式で書かれており、整合性がありません。良い例では、全て の項目が「~する」という動詞の形で統一されているため、リストが整然としており、情報が明確に伝 わります。
「健康的な生活を送るためには、バランスの取れた食事を食 べる、定期的な運動、ストレスを管理することが大切です。」 上記文のリスト項目を並列にしてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「健康的な生活を送るためには、バランスの取れた食事を食べる、定期的な運動、ストレスを管 理することが大切です。」 リストを並列にするためには、最初の項目の文法形式を定め、残りの項目もそれに合わせて修正しま す。この場合、全ての項目を動詞の「~する」という形式で統一することで、リスト内の並列性が保た れます。これにより、リストからの情報の受け取りが容易になります。 健康的な生活を送るために重要なこと: • バランスの取れた食事を食べる
• 定期的に運動する • ストレスを管理する
トレーニング: 手順説明の番号付きリスト項 目は辞書形の単語を用いる
Why? 番号付きリストは通常、手順や指示を示すために使用されます。各項目を辞書形で始めること で、行動を促す明確な指示として機能し、読者に対する次のステップが直接的に伝わります。 What? 辞書形は動詞の原形で、行うべき具体的なアクションを示す際に用いられます。手順説明の番 号付きリストでは、これを使用して各ステップの実行を促す明確な指示を提供します。 How? リストの各項目を作成する際に、動詞の原形を用いて始めます。これにより、各項目が直接的な 行動指示となり、プロセスの実行に必要な手順が明確に示されます。
悪い例 リスト項目が辞書形で始まっていない: 1. 確認が必要です。 2. ファイルを開いてください。 3. 情報を入力してください。 良い例 リスト項目がすべて辞書形で始まる:
1. 確認する。 2. ファイルを開く。 3. 情報を入力する。 悪い例ではリストの項目が辞書形で統一されておらず、手順が指示ではなく提案や要求のように見え ます。良い例ではすべての項目が辞書形で始まっており、読者に対して明確な行動を伝えることがで きます。
「ソフトウェアのインストール手順は、次のようになります。1. インストーラーをダウンロードしてください。2. ダブルクリックし て実行します。3. 画面の指示に従ってください。」 上記の指示をすべての項目が辞書形で始まるように修正して ください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「ソフトウェアのインストール手順は、次のようになります。1. インストーラーをダウンロードして ください。2. ダブルクリックして実行します。3. 画面の指示に従ってください。」 各項目を辞書形で始めることで、リストが手順の明確なガイドとして機能し、読者は何をすべきかを容 易に理解できます。これにより、行動指示の明確さと、手順の実行に対する読者の自信が高まりま す。
ソフトウェアのインストール手順: 1. インストーラーをダウンロードする。 2. ダブルクリックして実行する。 3. 画面の指示に従う。
トレーニング: リストと表を適切に紹介する
Why? リストや表は情報を整理し視覚的に表現する強力な手段ですが、これらを文脈なく提示すると、 読者はその情報の目的や重要性を見落とす可能性があります。 What? 文書ではリストや表を使用する前に、その目的や内容について適切な導入を提供する必要が あります。これにより、読者はリストや表を見る前に、何について読むのか、どういう情報が提供 されているのかを理解できます。 How? リストや表を文書に導入する際は、直前の文でそのリストや表が何を示しているのかを説明しま す。また、リストや表の見出しを使って、内容を要約し、読者がスムーズに情報を受け取れるよう
にします。
悪い例 「以下の通りです。」 良い例 「次の表は、各部署の四半期ごとの売上を示しています。」 悪い例ではリストや表の紹介があいまいであり、読者は提示された情報の意味を推測しなければなり ません。良い例では、表が何を示しているのかを明確に紹介しているため、読者はどの情報に注意を 払うべきかをすぐに理解できます。
「次の情報をご覧ください。」 上記のフレーズを使用せずに、顧客の年齢層別の商品購入 率を示す表を導入してください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「次の情報をご覧ください。」 表を導入する際には、それが何を示しているのか、どのような価値があるのかを説明すること が重要です。これにより、読者は表の情報を文脈の中で解釈し、関連するデータに注目できま す。 表だけでなく、図やキャプチャ画像・動画も同様に何に注目してほしいかを明確にする。 「以下の表は、顧客の年齢層別の商品購入率を示しています。」
トレーニング: 読者が理解しやすく関心を持 つ導入文を作成する
Why? 段落の最初の文は、読者がその段落で何について読むのかを理解するための道しるべとなり ます。強力な導入文は、段落の主題を明確にし、読者の関心を引き、情報の流れを整理する手 助けをします。 What? 各段落の開始文には、その段落の中心となるアイデアやポイントを明確に提示する内容を含め るべきです。これにより、段落の目的が明確になり、読者はその段落を読む動機を得ます。 How? 導入文を作成する際は、その段落で取り上げる主要なテーマや論点を簡潔に述べます。読者が その文を読んだ後には、段落の全体的な方向性が理解できるようにします。
悪い例 「たくさんのことが起きました。」 良い例 「過去四半期は、当社の成長にとって複数の重要な出来事があった期間でした。」 悪い例では導入文があいまいであり、具体的な情報を提供していません。良い例では、その段落が 過去四半期の重要な出来事に焦点を当てていることがすぐに理解できます。
「この部分では、当社の新しいマーケティング戦略について詳 しく説明します。」 上記の導入文を改善して、段落の中心点をより明確に表現し てください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「この部分では、当社の新しいマーケティング戦略について詳しく説明します。」 導入文を改善する際には、段落の主要なテーマや目的を具体的に述べ、読者が段落の内容を 素早く把握できるようにします。これにより、読者は段落を読む前に何を期待すべきかを明確に 理解し、引き続き読み進める動機付けを与えます。 「当社の革新的なマーケティング戦略は、顧客エンゲージメントを飛躍的に向上させるこ とを目指しています。」
トレーニング: 各段落を単一のトピックに集 中する
Why? 段落が複数のトピックにわたると、読者は主要なメッセージを見失いやすく、文章の流れが断片 化してしまいます。一つのトピックに焦点を当てることで、情報が整理され、理解しやすくなりま す。 What? 段落を構成する際には、一つの明確なトピックやアイデアに焦点を合わせ、そのトピックに関連 する情報を段落内で完結させます。これにより、段落ごとに情報を区切り、内容の理解と記憶を 促進します。 How? 新しいトピックを導入するときは新しい段落を始め、各段落の最初の文でそのトピックを紹介しま
す。段落内の文はすべてその中心トピックを支持し、補完する情報を提供するようにします。
悪い例 「私たちの製品は耐久性があり、使いやすく、環境にも優しいです。さらに、これらの製品を通じて新 しいマーケティング戦略を展開しており、販売促進活動を強化しています。顧客フィードバックも積極 的に取り入れ、サービスの質を向上させています。」 良い例 「私たちの製品は耐久性に優れており、長期間にわたり顧客に価値を提供します。この段落では製 品の耐久性とその顧客に対するメリットに焦点を当てて説明します。」 悪い例では、製品の特徴、マーケティング戦略、顧客フィードバックが一つの段落内で混在しており、 主題が不明瞭で読者は何に注目すべきかを判断しにくくなっています。良い例では、製品の耐久性と いう単一のトピックに焦点を当てることで、読者はその点に関する情報をしっかりと理解することがで
き、段落全体の流れが明確になります。
「私たちの製品は多くの利点があります。それは耐久性があ り、使いやすい、さらに環境にも優しいです。私たちはこれら の製品を使って、新しいマーケティング戦略を展開していま す。」 上記の段落から、単一のトピックに焦点を当てた段落を作成 してください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「私たちの製品は多くの利点があります。それは耐久性があり、使いやすい、さらに環境にも 優しいです。私たちはこれらの製品を使って、新しいマーケティング戦略を展開しています。」 段落の主題を特定し、そのトピックに関連する情報のみを含めることで、段落を単一のトピック に集中させます。余計な情報や異なるトピックは省略または別の段落で扱います。これにより、 段落はより整理され、読者は各セクションから得られる情報を明確に理解できます。 「私たちの製品の最大の利点はその耐久性です。耐久性に優れていることで、長期にわ たる使用が可能となり、顧客の満足度を高めます。」
トレーニング: 対象となる読者が何を学ぶ必 要があるかを決定する
Why? 読者が必要とする情報を提供しなければ、コンテンツは役に立たず、読者の時間を浪費するこ とになります。また、読者のニーズに合わせた情報を提供することで、効率的な学習と情報の有 用性が高まります。 What? 教材や文書を作成する際には、対象読者が新たに何を学ぶ必要があるのか、またはどのよう な問題を解決するために知識が必要なのかを特定します。これにより、内容をそのニーズに合 わせてカスタマイズし、より関連性の高い情報を提供できます。 How? 読者の背景、経験、既存の知識を理解し、彼らが求める情報や必要とするスキルを特定します。
アンケート、インタビュー、フィードバックの分析などを通じて、読者のニーズを明確にします。
悪い例 すべての読者に同じ一般的な情報を提供する。 良い例 初心者向けには基本的な概念から説明を始め、専門家向けには高度な分析や未解決の問題に焦 点を当てる。 悪い例では、読者の具体的なニーズに関わらず一般的な情報のみを提供しており、読者にとっての 価値が限定的です。良い例では、読者の学習レベルやニーズに合わせて情報を調整し、各読者が求 める知識を得られるようにしています。
「コンピュータの基本操作を学ぶ」という一般的な目的から、 読者が具体的に何を学ぶ必要があるかを決定してください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「コンピュータの基本操作を学ぶ」という一般的な目的から、読者が具体的に何を学ぶ必要が あるかを決定してください。 読者が学ぶべき内容を決定する際には、具体的な学習目標を設定し、それらの目標が読者の ニーズに合致しているかを確認します。初心者のニーズに応じて基本操作から教育を始めるこ とで、彼らにとって価値ある学習経験となります。 初心者読者は、コンピュータの起動とシャットダウンの手順、基本的なファイル管理、イ ンターネットのブラウジング方法を学ぶ必要があります。
トレーニング: 文書を読者に合わせて適合さ せる
Why? 文書が読者の知識レベルやニーズに合っていない場合、内容は彼らにとって理解しにくく、また 実用性に欠けるものとなります。読者の状況に合わせた文書を提供することは、情報の効果的 な伝達と利用の促進に不可欠です。 What? 文書を作成する際には、その内容がターゲットとする読者層の興味、理解レベル、文化的背景 に合致していることを確認し、それらに合わせて内容を調整します。これにより、読者が文書か ら最大限の価値を得られるようにします。 How? 読者のプロファイルを分析し、彼らがどのような情報を求めているのか、またどのフォーマットが
最も適しているのかを特定します。用語の選択、内容の深さ、視覚的要素の使用、文書の構造な ど、読者のニーズに合わせて各要素をカスタマイズします。
悪い例 専門家にも非専門家にも同じ高度な技術文書を使用する。 良い例 非専門家向けにはより簡潔で分かりやすい言葉を使用し、専門家向けには詳細なデータ と分析を提供する。 悪い例では、読者の専門知識レベルに関わらず同じ技術文書を提供していますが、非専門家には理 解が難しい可能性があります。良い例では、読者の背景に応じて文書がカスタマイズされており、各 読者が必要とする情報を得られるようになっています。
「インターネットのセキュリティに 関 するガイド」を 一 般 のイン ターネットユーザーとIT専門家の両方に向けて書く場合、どの ように内容を調整すべきか述べてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「インターネットのセキュリティに関するガイド」を一般のインターネットユーザーとIT専門家の 両方に向けて書く場合、どのように内容を調整すべきか述べてください。 文書を読者に合わせて調整する際は、読者の知識レベルと情報ニーズを評価し、適切な深さと専門 性を持たせた内容を提供することが重要です。一般ユーザーには基本を、専門家には詳細な分析を 行うことで、それぞれのグループに最も適した情報を提供できます。 一般のインターネットユーザー向けには、セキュリティの基本的な原則と簡単な予防策 を平易な言葉で説明します。IT専門家向けには、高度なセキュリティ脅威や対策技術、 業界のベストプラクティスに深く踏み込んだ内容を提供します。
トレーニング: 文書の冒頭で主要なポイント を確立する
Why? 文書の初めにキーポイントを設定することで、読者は文書全体を通じて期待すべき内容の概要 をすぐに把握できます。これにより、読者の関心を引き、重要な情報に対する理解を深めること ができます。 What? 文書作成時には、冒頭で文書の目的、範囲、および読者が学ぶことになる主要なテーマやアイ デアを明確に提示します。これは、読者に文書の方向性を示し、文書全体を通じてのコンテキス トを提供するために不可欠です。 How? 文書の導入部には、文書の目的を簡潔に説明し、主要なトピックや論点を概説することで、文書
の構造を明確にします。読者が最も注意を払うべきポイントを強調し、その後の詳細に備えま す。
悪い例 文書の主要なポイントを文書の中盤や終わりにしか提示しない。 良い例 文書の冒頭で「このレポートでは、最新の市場動向と来年度の販売戦略について詳細に 分析します」と明確に述べる。 悪い例では、読者が文書の目的や主要なポイントを理解するために多くの時間を費やす必要があり ます。良い例では、文書の冒頭でキーポイントを明示しているため、読者は冒頭で文書の目的と構成 を理解し、関連情報に注意を集中させることができます。
「新しい社内ポリシーに関する文書」を作成する際に、冒頭で どのようなキーポイントを設定するべきか述べてください。 トレーニングしましょう!!
トレーニングしましょう!! 正解 「新しい社内ポリシーに関する文書」を作成する際に、冒頭でどのようなキーポイントを設定す るべきか述べてください。 文書のキーポイントを冒頭で設定する際には、文書の目的と主要な内容を簡潔に説明し、それらのポ イントを強調して読者の理解を助けます。これにより、読者は文書の残りの部分を読む際に何に注目 すべきかが明確になります。 文書の冒頭で「この文書は、労働時間の変更、リモートワークのガイドライン、および新 しい社内コミュニケーションポリシーに関する最新の更新を概説します」と明確に述べま す。
参考文献 Google Technical Writing Courses