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

テクニカルライティングとは,目的あるいは読者対象に応じて技術を的確かつわかりやすく文書に表すための知識と手法の体系です.

  • テクニカルライティングは,「文章の書き方」 をはじめ「見出し構成の考え方」,「見やすい図・表の作り方」さらには「用語の使い方」,「文書書式の選び方」など文書作成に必要な基礎知識と応用手法で構成されています.

  • テクニカルライティングは,技術文書のみならずビジネス文書(ビジネスドキュメント)を含めた実務文書あるいはプレゼン資料の作成にも役立ちます.また,見やすい電子文書を作成する際にも有効です.

文書作成は,まさに知的生産です.企業では,多くの時間が文書作成に費やされています.テクニカルライティングは,文書作成の効率化とともに文書品質ならびに知的生産力の向上につながると確信します.当サイトが技術文書・ビジネス文書を作成する際の一助になれば幸いです.

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

 

 

〈上図は各関連コーナーにリンクされています〉

 

当サイトの主旨

当サイト「わかりやすい技術文書・ビジネス文書の作成手法」は,当社のテクニカルライティング研修コース(出張開催セミナー)の抜粋・プレビュー版です.

  • 技術文書を含む実務文書を作成する際の共通基礎と技術文書の目的(報告書,製品解説・マニュアル,機能仕様書など)に応じた応用手法を解説します.

  • また,基礎知識とともにいつくかの陥りやすい事例と見直しの指針を示します.

更新のご案内


イントロダクション

テクニカルライティングの目的は,「読者の理解の獲得」と「文書作成の効率化」の両立です.テクニカルライティングは ,執筆者の皆さんの文書作成を否定するものではありません.皆さんがおもちの知識や手法の再構成であり補完です.

〈下図はサンプル(抜粋・縮小版)です〉

.
   

テクニカルライティングの効用
文書品質の向上と文書作成時間の短縮 
− 「書く」から導かれる知的生産力−

企業にとっての文書作成の重要性とテクニカルライティングの効用を解説します. テクニカルライティングをとおして文書作成の進め方を見直すと,文書作成の効率化と文書品質の向上につながります.

  • コーナーはPDFファイル版でもご覧いただけます.

.
   

技術文書の「書き方 − 共通のポイントと各種文書への応用−

「ワープロの手が進まない」の打開につながるテクニカルライティングの基本手法を解説します.さらに,これを各種の技術文書(報告書, 製品解説・マニュアルあるいは機能仕様書など)の書き方に展開します.

 
.


 
文書構成の考え方

見出しを受けた段落で要点を述べ,箇条書き,図・表あるいは注記で要点を裏付けるのがわかりやすい技術文書のポイントです.

〈下図はサンプル(抜粋・縮小版)です〉

.

第1部 見出し構成の考え方

ページ数あるいは文書目的(報告書,製品解説,機能仕様書など)に応じた見出し構成と見出し名の考え方を解説します.

.


第2部 段落構成の考え方と箇条書き注記の使い方

見出しに対応した段落を構成する際の考え方と箇条書き図・表あるいは注記の適切な使い方を解説します.

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


読みやすくかつわかりやすい文章を書くあるいは段落を効率よくまとめるには, 「執筆が進まない原因」と「読者の理解を阻害する原因」を把握し適切な執筆手法につなげる必要があります.

〈下図はサンプル(抜粋・縮小版)です〉

.


第3部 文章の書き方と段落のまとめ方

「語」を適切な「文章」につなげる手法とともに要点が明確な段落をまとめるポイントを解説します.

.


第4部 陥りやすい技術表現の見直し方

技術文書の文章表現で陥りやすい問題点(あいまい表現,冗長表現,技術文書になじまない表現)の事例と改善方法を抜粋で解説します. 加えて,句読点,記号を使う際の基本と留意事項を解説します.

.
  

第5部 誤解・違和感につながる文の見直し方

読者の理解を損なうおそれがある文(例:主語と述語の対応があいまいな文)とその見直し方を解説します.

.

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


技術文書の規範に基づくとともに見やすい図・表および文書の書式を選ぶ必要があります.また,わかりやすさにつながる“見せ方”の手法を知っておくと有効です.

〈下図はサンプル(抜粋・縮小版)です〉

.


第6部 の書式と 「図解」の手法

図・表を作成する際の書式と図・表を図解化するいくつかの手法を解説します.

.


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

印刷文書とともに電子文書にした際も読みやすい文書書式の基本を解説します.

.
 


用字用語の使い方


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

〈下図はサンプル(抜粋・縮小版)です〉

a
  

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

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

a
    

漢字書きひらがな書きの使い分け

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

 
    

読みが同じ漢字の使い分け

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

 

 
    

送り仮名の扱い方

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

 
    

外来語のカタカナ表記

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

 
        
a

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

当社では,少人数から開催可能なテクニカルライティング研修コース(出張開催セミナー)を ご用意しています.本セミナーは,当サイトと基盤になる考え方を同じにしていますが,実務知識と事例が中心の別構成・別内容です.

当社の関連サイトのご案内

当社では,「マニュアル作成」をテーマとした関連サイト「わかりやすいマニュアル作成のための 実践テクニカルライティングセミナーwww.yamanouchi-yri.com」を開設しています.


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

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

.

技術文書の1stステップ

 

当社の実務別技術文書セミナー
わかりやすい技術文書の作成手法との違い

テクニカルライティングセミナー「技術文書の1stステップ」の各編は,技術文書を作成する際の共通基礎を主体に構成されています.

対して,「わかりやすい技術文書の作成手法」の各編は文書目的ごとに「いかに文書を構成し,まとめるか 」を主体に構成されています.


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


.

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

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

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


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

.


実務別技術文書セミナー

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

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

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

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

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

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

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

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

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

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



マニュアル作成セミナー

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

.

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

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

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


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

.

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

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

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


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

.



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


わかりやすいプレゼン資料の作成手法

出張開催セミナー「テクニカルプレゼンテーションの手法」の抜粋・プレビュー版です. 「聴き手の課題」を的確にとらえ「技術に裏付けられた解決策」を提案するプレゼン資料の構成法と表現手法を解説します.

〈下図はサンプル(抜粋・縮小版)です〉

..


追補」と「改訂

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

 
..


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

当社では,各種の技術文書およびマニュアルの作成に関するセミナー,コンサルティングを実施しています.

.


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


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

.


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


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

.


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