内容が明確に伝わる技術文書の書き方(その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日

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
知って得する人的資源マネジメント、熟達、6つの美徳と24の徳性【連載記事紹介】 

   【目次】 ◆ 熟達とは 前回の知って得する人的資源マネジメント、自律性【連載記事紹介】では、内発的動機づけ...

   【目次】 ◆ 熟達とは 前回の知って得する人的資源マネジメント、自律性【連載記事紹介】では、内発的動機づけ...


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

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!   今回は、「ルール6:明確に伝わる文...

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!   今回は、「ルール6:明確に伝わる文...


モチベーションのリスキリング【厳選記事紹介】モチベーション理論

     ◆ モチベーションのリスキリング 技術の世界に生きる私たちは、日々、技術力に磨きをかけ、生産性や品質を常に改...

     ◆ モチベーションのリスキリング 技術の世界に生きる私たちは、日々、技術力に磨きをかけ、生産性や品質を常に改...


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

もっと見る
製造業の価格交渉とは (タフネゴシエーターの名言)(その1)

        常々、私が思っていることですが、どんなに高く苦労してモノにした技術であっても、それを高く売る...

        常々、私が思っていることですが、どんなに高く苦労してモノにした技術であっても、それを高く売る...


部下の育成とは:物流管理者の育て方(その3)

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...


やろうと思っているけどできないことばかり、の克服(その1)

 やろうと思っているけどできないことってありますね。ぼくもやろうと思っていることがたくさんあるのにできないことばかりです。コーチングでもよくあるテーマです...

 やろうと思っているけどできないことってありますね。ぼくもやろうと思っていることがたくさんあるのにできないことばかりです。コーチングでもよくあるテーマです...