わかりやすい技術文書・ビジネス文書の作成手法

山之内孝明(山之内総合研究所・代表)takaaki@yamanouchi-yri.com

内容の更新出張開催セミナーのご案内

  • 文章のまとめ方とチェックポイント「違和感につながる文構造の見直し追加しました(2009/4).

  • 上記「違和感につながる文構造の見直し」は,当社のマニュアル作成セミナー「わかりやすいマニュアルの作成手法」,実務別技術文書セミナー「わかりやすい技術文書の作成手法」およびテクニカルライティングセミナー「技術文書の1stステップ」 (各出張開催形式)からの抜粋・要約です.

 


 

イントロダクション
  • わかりやすい技術文書(テクニカルドキュメント)作りには,文章のまとめ方や図・表の作成方法とともに読者の理解に配慮した文書を作成するための具体的な手法テクニカルライテング)を理解しておくことが有効です.また,技術文書の目的(報告文書あるいは解説文書)に応じたポイントと陥りやすい問題点を知っておくことも大切です.

.

序説 わかりやすい技術文書へのアプローチ

  • 「読者にとってわかりやすい技術文書」を作成するために執筆者が知っておかなければならないポイントを解説します.また,報告文書(技術報告,研究報告)と解説文書(製品解説,製品仕様書,技術解説)の共通点と違いについても解説します.

.


 
文書構成の考え方

  • 技術文書,ビジネス文書を問わず目次は,文書の全体構成を示すとともに各項目の内容を要約して示すもので,読者にとっては「理解の道標」となる要素です.

.

第1部 目次構成の考え方と見出し名の付け方

  • 技術文書作りの第一歩は,目次構成を考えることです.第1部では,「章」・「節」・「項」による目次構成の考え方と「見出し番号」,「見出し名」の付け方を解説します.

.


第2部 段落構成の考え方

  • わかりやすい文書であるためには目次構成とともに「段落構成」が明解でなければなりません.報告文書,解説文書それぞれの段落構成の基本を解説します.

a
 
文章のまとめ方とチェックポイント


  • 簡潔で明解な文章を書くためには,基本となるポイントをおさえておく必要があります.また,わかりやすい文章を書くためには「書くだけではなく見直す」ことも欠かせません.

.


第3部 文章のまとめ方

  • 報告文書で使う文章を「解説文」,「宣言文」,「指示文」に類型し,それぞれのポイントを解説します.また,技術文書でよく使われる複文(主節−従節構造)の使い方について事例で解説します.

.


第4部 文章のチェックポイント

  • 技術文書の文章表現で陥りやすい問題点(あいまい表現,冗長表現,技術文書になじまない表現)の事例と改善方法を解説します.

  

第4部追補 違和感につながる文構造の見直し

  • 時間をかけてまとめた技術文書も,読者に「“主語と述語が対応しない”不自然な文章が多い」と受け取られては意味がありません.いくつかのチェックポイントを念頭に技術文を見直す必要があります.当コーナーでは,読者の理解を損なうおそれがある文例とその見直し方を解説します.

 
.

図・表の作成とレイアウトの手法


  • 技術文書ではわかりやすい図・表を使い,視覚的かつ説得力のある内容・構成にする必要があります.また,ワープロのスタイル機能・レイアウト機能を効果的に使い見やすい文書レイアウトに仕上げることが必要です.

.


第5部 わかりやすい図・表の作成手法

  • 図・表を作成する際の「基本書式」と図・表を「わかりやすくする工夫」を解説します.また,解説文との適切な対応付けについても解説します.

.


第6部 文書レイアウトの基礎 - 読みやすいワープロ文書のポイント -

  • ワープロで文書を作成する際の基本的な書式とレイアウトの知識を解説します.

.
 

用字用語の使い方


  • 技術文書のみならずビジネス文書も,適切な用語を統一して使うことが基本です.

a


第7部 用字用語の考え方と用例

  • 用語を使う際に陥りやすいポイントと用語を統一するための手法を解説します.

. a
a

  • 「常用漢字表」をもとに,用語の漢字書きが適当な例,ひらかな書きが適当な例を解説しています.あわせ用法によって使い分けが必要な例を示します.


  • 外来語をカタカナ表記する際に不統一となりやすい「長音(音引き)の扱い方」,「外来音の当て方」,「欧文の分かち書きの扱い方(中点の有無)」について解説します.
.

  • 送り仮名の扱い方の原則と慣用をよく使う事例・用法の一覧とともに解説します.


  • よく使う「同音類義語」,「異字同訓語」とその用例を一覧します.
.

a

 
テクニカルライティングセミナー


テクニカルライティングセミナー(出張開催形式)技術の1stステップ」,(同)+技術メール編」,(同)+ビジネス文書編」,(同)+ワープロレイアウト編」では,要点が明確な技術文書を作成するための共通基礎と手法を事例中心で解説します.
.

技術文書の1stステップ


技術文書の1stステップ+技術メール編

  • 技術文書の共通基礎と「要点がわかる」文書作成のポイントを解説


  • 「技術文書の1stステップ」に技術メールのポイント,敬語表現の使い方を追加した拡張版
.

技術文書の1stステップ+ビジネス文書編


技術文書の1stステップ+ワープロレイアウト編

  • 「技術文書の1stステップ」にビジネス文書(社内文書・社外文書)の基本,敬語表現の使い方を追加した拡張版


  • 「技術文書の1stステップ」にワープロでできるレイアウトの手法といくつかの事例を追加した拡張版
.



実務別技術文書セミナー

実務別技術文書セミナー(出張開催形式)わかりやすい技術文書の作成手法」は,業務で作成する機会の多い文書に応じた「コース選択式」です.各コースごとに必要な考え方・手法・ポイントを事例中心で解説します.
.

わかりやすい技術文書の作成手法

わかりやすい技術文書の作成手法<試験報告・調査報告編>

わかりやすい技術文書の作成手法<製品解説・技術解説編>

わかりやすい技術文書の作成手法<報告文書+解説文書編>

わかりやすい技術文書の作成手法<報告文書+機能仕様書編>

わかりやすい技術文書の作成手法<機能仕様書+製品解説編>

わかりやすい技術文書の作成手法<機能仕様書+技術メール編>

わかりやすい技術文書の作成手法<製品解説+技術メール編>
.

テクニカルプレゼンテーションの手法
.



マニュアル作成セミナー

マニュアル作成セミナー(出張開催形式)わかりやすいマニュアルの作成手法」では,「これからマニュアルを作成する」あるいは「見直しをしたい」方々のために基礎と実務知識実用例・参考例で解説します.
.

わかりやすいマニュアルの作成手法<取扱いマニュアル編>


わかりやすいマニュアルの作成手法<システム操作マニュアル編>

  • 取扱いマニュアル(家電製品・情報機器,試験装置・製造装置,その他)を作成する際のポイントを基本と事例で解説


  • システム操作マニュアル(電子申請システム,情報検索システム,業務支援システム,その他)を作成する際のポイントを基本と事例で解説
.

わかりやすいマニュアルの作成手法<図解マニュアル編>


わかりやすいマニュアルの作成手法<図解マニュアル編>

  • システムを導入した業務(顧客対応,各種管理など)のマニュアルを作成する際のポイントを基本と事例で解説


  • 製品あるいはソフトウェアの操作を図解でわかりやすく示す「図解マニュアル」を作成する際のポイントを基本と事例で解説
.




技術文書・ビジネス文書に役立つ知識


わかりやすいプレゼンスライドの作成手法


..


わかりやすい文書が誰にもすぐに作れる

- 「原稿用紙で200枚分くらいの文書を作ってみたい」が実現する -

  • どうしたら「わかりやすい文書が楽に作れる」ようになるのでしょうか.ここでは「書けない」から「書ける」になるためのキーポイントを提案します. とくに,誰もが経験する「書き進めているうちに行き詰まってしまう」状況を打開するためのテクニックを紹介します.

..


原稿指定と校正 - 覚えておきたい編集作業の基本 -

  • 原稿を作成するだけがテクニカルライティングではありません.原稿執筆が完了してから印刷物になるまでの基礎知識を解説します.

..


「追補」と「改訂」

  • 文書の第1版発行後に内容を追加・修正し改訂版を発行する際の方法を解説します.

..



出張開催セミナーとコンサルティングのご提案

  • 当社では各種技術文書の作成に関するコンサルティングを行っています.
.

マニュアル作成コンサルティング
.

セミナー/コンサルティングFAQ
.

セミナー開催概要<一括版>
.

セミナー基本料金<参考例>
.



テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー
わかりやすい技術文書・ビジネス文書の作成手法
Copyright:Takaaki-YAMANOUCHI/1995-2009
山之内孝明/(有)山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
 takaaki@yamanouchi-yri.com