技術文書の書き方−テクニカルライティングセミナー わかりやすい技術文書の作成手法− 

 

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


当サイトの主旨

技術者の皆さんが技術文書あるいは 技術に関連したビジネス文書を作成される際に役に立つテクニカルライティング(「文章の書き方」 をはじめ「見出し構成の考え方」、「見やすい図・表の作り方」さらには「用語の使い方」、「書式の選び方」など)の基礎知識と応用手法を概説します。

文書作成は、まさに知的生産です。企業では、多くの時間が文書作成に費やされています。テクニカルライティングは、文書作成の効率化とともに文書品質ならびに知的生産力の向上につながると確信します。当サイトと当社の出張開催セミナー・コンサルティングが技術文書を作成する際の一助になれば幸いです。


当社の出張開催セミナー

技術文書およびマニュアルに関する出張開催セミナーテクニカルライティング研修コースをご用意しています。技術文書のポイントと事例・演習で構成した基礎コースをはじめ、技術文書の目的(報告書、製品解説・マニュアル、機能仕様書)ごとの応用コース、さらにはコンサルティングを組み合わせたコースから選べます。当サイトの閲覧とあわせて出張開催セミナーをぜひご検討ください。

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

 

わかりやすい文書とテクニカルライティング テクニカルライティングの知識と手法 出張開催セミナーの概要
わかりやすい技術文書へのアプローチ 文書構成の考え方 テクニカルライティングセミナー
テクニカルライティングの効果 文章の書き方とチェックポイント 実務別技術文書セミナー
技術文書・ビジネス文書に役立つ知識 図・表の作成とレイアウトの手法 マニュアル作成セミナー
当社の関連サイト 用字用語の使い方 インフォメーション


テクニカルライティングの効果

テクニカルライティングの目的は、「読者の理解の獲得」と「文書作成の効率化」の両立です。

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

.
   

文書品質の向上と文書作成時間の短縮 −「書く」から導かれる知的生産力−

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

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

.

トップに戻る


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

テクニカルライティングの基本を知り応用に結びつければ、文書作成への苦手意識を克服できます。

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

.
   

 技術文書の書き方  -Part 1: 共通のポイント-

「どのように書けば、伝わりやすいのか」をテーマにテクニカルライティングの基本を解説します。

 
.
   

技術文書の書き方 -Part 2: 各種文書への応用-

テクニカルライティングの基本を報告書、 製品解説、機能仕様書などの書き方に展開します。

 
.

トップに戻る


文書構成の考え方

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

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

.

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

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

.


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

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

a

トップに戻る


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


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

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

.


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

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

.


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

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

.
  

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

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

.

トップに戻る


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


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

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

.


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

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

.


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

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

.

トップに戻る


用字用語の使い方


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

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

a
  

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

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

a
    

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

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

 
    

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

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

 

 
    

送り仮名の扱い方

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

 
    

外来語のカタカナ表記

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

 
        
a

トップに戻る


出張開催セミナー

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

関連サイト

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

トップに戻る


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

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

.


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


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

.


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


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

.

トップに戻る


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

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

.



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


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

.



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


「技術文書の1stステップ」にプレゼンスライドを作成する際の基本とポイントを追加した拡張版です。

.

トップに戻る


実務別技術文書セミナー

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

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


  


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

  


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

  


  


  


.

.

トップに戻る


マニュアル作成セミナー

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

.



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


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

.



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


製造工程での組立て作業あるいは製品の整備・改修作業などを想定した作業手順書のポイントを基本と事例で解説します。

.

トップに戻る


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



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

技術文書もプレゼンも要点を的確に伝えることが何よりも重要です。「聴き手の課題」を的確にとらえ「技術に裏付けられた解決策」を提案するプレゼン資料の構成法と表現手法を解説します。

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

..


電子マニュアルの考え方とタブレット端末で読める電子版図解マニュアルの作り方

マニュアルを電子化する際のポイントを解説します。また、「タブレット端末で読める」をテーマに文書スタイルの電子マニュアルの作り方を概説します。さらには、「真に印刷文書に置き換わり、かつマニュアルならではのインタラクティビティを備えた動画マニュアル」の具体像を論じます。

..


追補」と「改訂

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

 
..

トップに戻る


技術文書の書き方−テクニカルライティングセミナー わかりやすい技術文書の作成手法−
Copyright: Takaaki-YAMANOUCHI/1995-2017
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.

 takaaki@yamanouchi-yri.com