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

お知らせ

本サイトは、2024年3月30日をもって終了します。長期のご利用ありがとうございました。

 


上記に伴って、本サイトの内容を再編して komei68.blogspot.com 「技術文書の書き方」に公開しました。以降は、こちらの利用をいただけますと幸いです。

 

わかりやすい文書とテクニカルライティング テクニカルライティングの知識と手法
わかりやすい技術文書へのアプローチ 文書構成の考え方
テクニカルライティングの効果 文章の書き方とチェックポイント
技術文書・ビジネス文書に役立つ知識 図・表の作成とレイアウトの手法
当社の関連サイト 用字用語の使い方


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


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

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

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

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

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

トップに戻る


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


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


  

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

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

  

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

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

トップに戻る

文書構成の考え方


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


  

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

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

  

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

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

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


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


  

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

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

  

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

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

  

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

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

トップに戻る


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


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


  

第6部 書式と図解手法

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

  

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

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

トップに戻る


用字用語の使い方


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


   

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

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

   

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

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

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

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

送り仮名の扱い方

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

外来語のカタカナ表記

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

 

トップに戻る


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


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

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


   

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

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

   

追補」と「改訂

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

 

 

トップに戻る


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

 takaaki@yamanouchi-yri.com