内容が明確に伝わる技術文書の書き方(その10)

投稿日

技術文書

 

今回は、「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説します。「6つのルールと18の書き方」を以下に示します。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その9)へのリンク】 

 

人財教育

 

1.ルール1:冒頭に書く

ルール1とは、内容に関する主要なことを冒頭に書き、この主要なことに関する説明をその後に書くことです。

 

1.1 書き方1:要点を冒頭に書く

書き方1とは、内容に関する要点を冒頭に書き、この要点に関する説明をその後に書くことです。

 

1.2 書き方2:全体像を冒頭に書く

書き方2とは、伝える内容の全体像を冒頭に書き、伝える内容の詳細をその後に書くことです。

 

1.3 書き方3:枠組みを冒頭に書く

枠組みとは“目的・方針・手順”のことです。書き方3とは、この枠組みを技術文書の冒頭に書き、この枠組みに対応した内容をその後に書くことです。

 

2.ルール2:ペアで書く

ルール2とは、2つのことをペア(対)で書くことです。

 

2.1 書き方4:根拠を書く

書き方4とは、書き手が決めたこと(決定事項)あるいは書き手が判断したこと(判断事項)を書いたら、決定事項あるいは判断事項とこれらの根拠を各々ペアで書くことです。

 

2.2 書き方5:条件を書く

書き方5とは、条件によって結果が変わる内容を書く場合には条件と結果をペアで書くことです。

 

3.ルール3:分けて書く

ルール3とは、内容を分けて書くことです。

 

3.1 書き方6:かたまりに分けて書く

書き方6とは、かたまりに分けて内容を書くことです。
注):書き方の第2原則(内容が明確に伝わる構成を考える)は書き方6と関係があります。前回の記事の中で、「内容が明確に伝わる技術文書の構成を考えるうえでの4つのポイント」を解説しました。1番目のポイントは「内容を項目に区分する」ですが、これは書き方6を適用した考え方です。内容をかたまりに分けることで(内容を項目に区分することで)内容が明確に伝わる技術文書の構成を考えることができます。

 

3.2 書き方7:箇条書きで書く

書き方7とは、箇条書きで内容を書くことで...

技術文書

 

今回は、「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説します。「6つのルールと18の書き方」を以下に示します。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その9)へのリンク】 

 

人財教育

 

1.ルール1:冒頭に書く

ルール1とは、内容に関する主要なことを冒頭に書き、この主要なことに関する説明をその後に書くことです。

 

1.1 書き方1:要点を冒頭に書く

書き方1とは、内容に関する要点を冒頭に書き、この要点に関する説明をその後に書くことです。

 

1.2 書き方2:全体像を冒頭に書く

書き方2とは、伝える内容の全体像を冒頭に書き、伝える内容の詳細をその後に書くことです。

 

1.3 書き方3:枠組みを冒頭に書く

枠組みとは“目的・方針・手順”のことです。書き方3とは、この枠組みを技術文書の冒頭に書き、この枠組みに対応した内容をその後に書くことです。

 

2.ルール2:ペアで書く

ルール2とは、2つのことをペア(対)で書くことです。

 

2.1 書き方4:根拠を書く

書き方4とは、書き手が決めたこと(決定事項)あるいは書き手が判断したこと(判断事項)を書いたら、決定事項あるいは判断事項とこれらの根拠を各々ペアで書くことです。

 

2.2 書き方5:条件を書く

書き方5とは、条件によって結果が変わる内容を書く場合には条件と結果をペアで書くことです。

 

3.ルール3:分けて書く

ルール3とは、内容を分けて書くことです。

 

3.1 書き方6:かたまりに分けて書く

書き方6とは、かたまりに分けて内容を書くことです。
注):書き方の第2原則(内容が明確に伝わる構成を考える)は書き方6と関係があります。前回の記事の中で、「内容が明確に伝わる技術文書の構成を考えるうえでの4つのポイント」を解説しました。1番目のポイントは「内容を項目に区分する」ですが、これは書き方6を適用した考え方です。内容をかたまりに分けることで(内容を項目に区分することで)内容が明確に伝わる技術文書の構成を考えることができます。

 

3.2 書き方7:箇条書きで書く

書き方7とは、箇条書きで内容を書くことです。

 

3.3 書き方8:表で書く

書き方8とは、表で内容を書くことです。

 

次回に続きます。

【参考文献】

森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日

 

関連解説記事「相手の立場に立って考える」こと 

 

   続きを読むには・・・


この記事の著者

森谷 仁

「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!

「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!


「人財教育・育成」の他のキーワード解説記事

もっと見る
「業務内容の詳細」の書き方のポイント(技術士第二次試験対策を例に)

 今回の記事は、「わかりやすい文書の書き方」の考え方を参考にしながら「業務内容の詳細」の書き方のポイントを解説します。   技術士第二次試験...

 今回の記事は、「わかりやすい文書の書き方」の考え方を参考にしながら「業務内容の詳細」の書き方のポイントを解説します。   技術士第二次試験...


寄り添うリーダーシップ、支援上手でお互いの価値観を認めるリーダーとは

   【目次】 新人のモチベーションアップと維持を支援するためには、どのようなアプローチが必要なのでしょうか?ヒン...

   【目次】 新人のモチベーションアップと維持を支援するためには、どのようなアプローチが必要なのでしょうか?ヒン...


教育スタイルを変えて、パフォーマンスを高めよう

  ある組織での話です。ここは、工場長・部長・課長・係長・現場リーダーの階層に分かれた組織でした。ある時、現場リーダーにたいして「洞察力を...

  ある組織での話です。ここは、工場長・部長・課長・係長・現場リーダーの階層に分かれた組織でした。ある時、現場リーダーにたいして「洞察力を...


「人財教育・育成」の活用事例

もっと見る
コンプライアンス意識を持とう:職場のマネジメント

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...


人財教育・人材育成、仕事の影響力を高め、仕事の満足度を高めるには

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 継続的に成果を出して仕事の影響力を高める 仕...

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 継続的に成果を出して仕事の影響力を高める 仕...


【SDGs取り組み事例】自然と社会との共生を目指して 日本テクノ株式会社

従業員主体で環境保護、サステナビリティへの取り組み SDGs(持続可能な開発目標)の観点からみても重要な取り組みとして注目されている「エコチューニン...

従業員主体で環境保護、サステナビリティへの取り組み SDGs(持続可能な開発目標)の観点からみても重要な取り組みとして注目されている「エコチューニン...