わかりやすいマニュアル作成のための実践テクニカルライティン … · イル，PDFファイル）を各種の文書作成の参考にしていただくこと

実践テクニカルライティングセミナー実践テクニカルライティングセミナー実践テクニカルライティングセミナー実践テクニカルライティングセミナー実践テクニカルライティングセミナー実践テクニカルライティングセミナー実践テクニカルライティングセミナー実践テクニカルライティングセミナーわかりやすいマニュアル作成のための

山之内総合研究所

2

「テクニカルライティング」とは「テクニカルライティング」とは

テクニカルライティングとは

• 技術的な内容を

– 製品の仕様・取扱い方法

• 読者対象や目的に応じて

– ユーザ向けマニュアル

• 効果的に表す手法

– わかりやすく正確に

0-1

3

「テクニカルライティング」の範囲「テクニカルライティング」の範囲

テクニカルライティングは

• 読者に理解してもらう文書作りの総合的な手法– 内容構成の検討から図・表による表現までを含む

• 単に“文章作成法”の範囲にとどまらない

0-2

［文書全体の構成］［文書全体の構成］［文書全体の構成］［文書全体の構成］

•目次の作り方

•見出しの付け方

［文書全体の構成］［文書全体の構成］［文書全体の構成］［文書全体の構成］

•目次の作り方

•見出しの付け方［本文の書き方］［本文の書き方］［本文の書き方］［本文の書き方］

•文書作成の基本ルール

•わかりやすい文書作り

［本文の書き方］［本文の書き方］［本文の書き方］［本文の書き方］

•文書作成の基本ルール

•わかりやすい文書作り

［ビジュアル化］［ビジュアル化］［ビジュアル化］［ビジュアル化］

•重要ポイントの強調

•イメージ，手順の図解

［ビジュアル化］［ビジュアル化］［ビジュアル化］［ビジュアル化］

•重要ポイントの強調

•イメージ，手順の図解

テクニカルライティング

4

「テクニカルライティング」の位置付け「テクニカルライティング」の位置付け

テクニカルライティングはエンジニアリング

• エンジニアが共通して知っておきたい技術文書の作成手法– 専門家「テクニカルライター」だけのものではない

• マニュアルライター，技術英文翻訳者，技術雑誌ライター

– マニュアル以外にも応用が可能

• 製品企画書，プレゼンテーション，その他

0-3

5

「テクニカルライティング」の目指すもの「テクニカルライティング」の目指すもの

0-4

•正確な表現

•執筆者の負担軽減（作業の効率化）

読者（ユーザ）執筆者（開発者）

マニュアル

•執筆者によるレベルのばらつきをなくす

•情報もれのない構成

•わかりやすさ

•検索性

•実用性

6

本セミナーの目的本セミナーの目的

本セミナーでは

• 正確でわかりやすいマニュアルを

• 効率よく作成するために必要な手法

を理解することを目指す

0-5

•現在のマニュアルをどう見直すか•現在のマニュアルをどう見直すか

•読者の視点で何をどのように書くか•読者の視点で何をどのように書くか

7

本セミナーの構成（前半）本セミナーの構成（前半）

• 第1部　わかりやすいマニュアルを作るためにわかりやすいマニュアルを作るためにわかりやすいマニュアルを作るためにわかりやすいマニュアルを作るために

– マニュアル作成の進め方

• 第2部　読者指向のマニュアルとは読者指向のマニュアルとは読者指向のマニュアルとは読者指向のマニュアルとは

– 読者の視点に立つポイント

• 第3部　目次作りのポイント目次作りのポイント目次作りのポイント目次作りのポイント

– 読者指向の構成とわかりやすい見出し

0-6

8

本セミナーの構成（後半）本セミナーの構成（後半）

• 第4部　原稿執筆のルール

– 技術文書を書くための基本

• 第5部　原稿執筆のポイント

– 正確でわかりやすい文章を書くために

• 第6部　ビジュアル化する

– 「読む理解」+「見る理解」の重要性

0-7

9

わかりやすいマニュアル作成のための

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

Ver.2.11999年11月11日

有限会社　山之内総合研究所

不許複製

© 山之内総合研究所 1999

COPYRIGHTCOPYRIGHT

1付

「「わかりやすいマニュアル作成のための実践テクニカルライわかりやすいマニュアル作成のための実践テクニカルライティングセミナーティングセミナー」をご覧いただき誠に有難うございます」をご覧いただき誠に有難うございます

• 当Webサイトからコピーあるいはダウンロードした内容（htmlファイル，PDFファイル）を各種の文書作成の参考にしていただくこと

は作者の意とするところであり，皆様のお役に立つことができれば誠に幸いです．

– ただし，内容の一部あるいは全部を他のWebサイトや他の出版物，

等に収録・再配布する，あるいは当社の著作物の二次使用は禁じておりますのでご承知ください．

(有)山之内総合研究所山之内孝明

[email protected]

ご挨拶

2付

マニュアル作成コンサルティングマニュアル作成コンサルティングのご提案のご提案

• 当方では，マニュアルをはじめとした各種の文書作成に関するコンサルティングのご相談をお受けしています．

– 「マニュアルをどのような構成したらよいのか」「どう改善すれば読者の理解を得られるのか」など個別の問題にお答えすることができると思いますのでご相談ください．

– コンサルティングの例

• テクニカルライティングセミナーの開催

• マニュアルクリニック

• 新規マニュアルの企画・製作コーディネート

• その他

– 原稿作成コンサルティング

– 原稿リライトコンサルティング

– 各種出版物（印刷物，電子出版物）の製作コンサルティング

ご提案

3付

コンサルティングのご提案コンサルティングのご提案そのその11テクニカルライティングセミナーの開催テクニカルライティングセミナーの開催

• 各種テクニカルライティングセミナーを実施行っています．（出張開催形式）

ご提案

各詳細は別紙「セミナー概要」をご覧ください．

4付

コンサルティングのご提案コンサルティングのご提案そのその22マニュアルクリニックの実施マニュアルクリニックの実施

• 御社で作成された（あるいは製作進行中）のマニュアルをユーザの視点でクリニックします．– マニュアルを拝見し，何を点を改善すると読者がより理解しやすくな

るかを具体的にご提案します．

• 目次構成のチェック

– 全体構成・細目構成の見直し，など

• 執筆内容のチェック

– 難解な表現，誤解をあたえやすい表現のチェック

– 用字・用語，文章表現のチェック，など

• ビジュアル表現のチェック

– 文章表現の図・イラスト化の提言，ページレイアウトへの提案，など

– OHPなどで解説し，質疑をお受けします．

ご提案

5付

コンサルティングのご提案コンサルティングのご提案そのその33新規マニュアルの企画・製作コーディネート新規マニュアルの企画・製作コーディネート

• これから製作するマニュアルの構成，執筆方法，その他についてコーディネート（各種支援）します．

– 企画コーディネート

• 目次（全体構成・細目構成）の検討

• ページ体裁（基本レイアウト）の検討

– 執筆コーディネート

• 執筆マニュアルの作成，執筆サンプルの作成

• 分担執筆の方法（複数の執筆者で執筆した場合の調整方法）

– 編集・校正，製作コーディネート

• 製作工程の管理（製作時間管理，コスト管理，品質管理）

ご提案

6付

有限会社山之内総合研究所

山之内孝明

Eメイル

[email protected]サイト

http://www.yamanouchi-yri.com/ （独自ドメイン）

http://www.asahi-net.or.jp/~wg5t-ymnu/（ミラーサイト）

連絡先

ご連絡はこちらへご連絡はこちらへ

1

2002 年 10 月

テクニカルライティングで考える

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

セミナー開催概要およびプログラム

有限会社山之内総合研究所 www.yamanouchi-yri.com

セミナーの主旨

「製品はわかりやすい取扱いマニュアルがあってはじめて商品になる」ともいえます．技術

者は技術や製品の開発のみならず，取扱いマニュアルの作成にもかかわることがしばしばあり

ます．一般ユーザを対象とした製品が広く受け入れられるためにも，また受注製品の顧客満足

度を上げるためにも「わかりやすい取扱いマニュアル」はかかせません．

その一方で，取扱いマニュアルを「作成するための手法」あるいは「評価する手法」についてはあ

まり知る機会がないのが現状です．その結果が「マニュアルが難解」という評価（さらには製品・

企業の評価）になり，その対応に不必要な時間とコストをかけることにもなります．

本セミナーでは，技術者が取扱いマニュアルを作成する際の，「構成の考え方」，「用語の使い

方と文章のまとめ方」．「ビジュアル化とレイアウトの方法」について，テクニカルライティング（技

術文書を作成するための体系的な手法）の視点で実務に反映しやすい事例で解説します．

セミナーの実施方法と概略構成

実施方法プレゼンテーションおよび質疑応答

対象者マニュアルを作成する機会のある技術者およびメーカのマニュアル製作担当者

製品解説文書を作成する機会のある技術者および文書管理担当者

参加者数 1 回当たり 30～40 名程度を想定

時間全 2 日間（半日 3 回の開催も可能）

講師山之内総合研究所山之内孝明

第 1 日第 2 日

（序部）マニュアルとテクニカルライティング第 7 部操作指示のまとめ方

第 1 部章構成・節構成の考え方第 8 部注意指示のまとめ方

第 2 部項構成とページ構成の考え方第 9 部レイアウトの手法

第 3 部見出し名の付け方第 10 部図・表のチャート化と図解の手法

第 4 部文章の考え方とまとめ方第 11 部用字用語の使い方

第 5 部解説段落のまとめ方第 12 部技術用語の使い方

第 6 部解説文のチェックポイント＊両日とも 10:00～17：00 を想定

（各部の詳細は次ページのプログラムをご参照）

本セミナーに関するお問合せ方法は，本資料の最後をご覧ください．

開催概要

http://www.yamanouchi-yri.com

セミナー開催概要－テクニカルライティングで考えるわかりやすいマニュアルの作成手法

2

プログラム（第 1 日）

（序部）マニュアルとテクニカルライティング ............................................ （第 1 日・午前）

当セミナーのイントロダクションとして，取扱いマニュアルの作成過程でしばしば陥る問題

点とこれを解決するテクニカルライティングの手法を概説します．

［注］以下の各項目はプレゼンスライドの抜粋・要約です．また，解説の順序は一部前後することがあります．（他も同様）

わかりづらいマニュアルの原因／製作方法の問題点／テクニカルライティングとは／本セミナーの構成

（プレゼンスライド全 10 枚）

第1部取扱いマニュアルの章構成・節構成の考え方 ................................... （第 1 日・午前）

章構成，節章目次を十分に検討することは，読者にとって必要な情報が見つけやすい（通し

ても読め，どこからでも読める）実用的な取扱いマニュアルにつながります．陥りやすい事例

をあげながら適切な章構成，節構成の考え方・作り方を解説します．

マニュアルの構成を検討するためのキーワード

「ユーザの視点」でキーワードを見つける／製品の設計思想はさまざまでもマニュアルの基本は同じ

章構成の考え方

目次要素の書出し／仮章構成の作り方／ページ数の調整／見出し名と見出し番号の調整／陥りや

すい事例／分冊型取扱いマニュアルの考え方／編構成の考え方

見出し番号書式の選び方

見出しレベルと見出し番号書式の関係／技術文書型とマニュアル型の見出し番号書式

節構成の考え方

節構成の基本／必要な項目を見つけやすくする工夫／陥りやすい事例／ページ数が多い場合の工夫

章構成・節構成の調整

章構成の調整と陥りやすい事例／節構成の調整と陥りやすい事例／章構成をわかりやすくする工夫


第2部取扱いマニュアルの項構成とページ構成の考え方 ............................ （第 1 日・午後）

章，節が読者に「マニュアルの構成」を示すのに対して，項構成は「解説（段落）の構成」

を示す道標といえます．また，取扱いマニュアルは「読者の目にどのように映り，どのように

理解されるか」を考えたページ構成にしなければなりません．第 2 部では，読者対象や目的に

応じた項構成，ページ構成を模擬事例で解説します．

項構成の考え方と調整

項構成の基本／項構成の調整／陥りやすいいくつかの事例

ページ構成の考え方

マニュアルのページを構成する要素／マニュアルの段落構成／マニュアルの目的に応じたページ構成

補足要素の使い方

補足文の使い方／注記の使い方



3

第3部解説文の書き方とそのチェックポイント........................................... （第 1 日・午後）

取扱いマニュアルの見出し名は，読者（ユーザ）が知りたい事項を的確に表していなければ

なりません．第 3 部では，取扱いマニュアルで使われるさまざまな見出し名のスタイルを整理

し，用途に応じた適切な使い方を解説します．

マニュアルで使う見出し名

読者にとってわかりやすい見出し名／マニュアルで使う見出し名の類型／見出し名のスタイルの使い分け

見出し名を使う際のポイント

章見出し名のポイント／節見出し名のポイント／項見出し名のポイント／いくつかの陥りやすい事例

注意して使う見出し名

用途を考慮する必要がある見出し名／使わないことが望ましい見出し名／いくつかの陥りやすい事例


第4部取扱いマニュアルで扱う文章の考え方・まとめ方 ............................ （第 1 日・午後）

取扱いマニュアルでは，「製品，マニュアルに関連する事項が主語になる文」，「執筆者あるい

はユーザが“省略された主語”になる文」，さらには「異なる主語で構成される複文」などさま

ざまな文章が使われます．第 4 部では，これらを分類して示し，それぞれのポイントを解説しま

す．

取扱いマニュアルで使う文章の考え方

マニュアルで使う文章の便宜的分類／マニュアルで使う文章の基本的な約束事

執筆者が主語になる文章のまとめ方

定義・命名する文章／マニュアルの内容を告知する文章／製品に関連する事項を告知する文章

製品の構成を解説する文章のまとめ方

製品の構成を解説する文章／マニュアルの構成を解説する文章／能動態と受動態の使い分け

製品の機能を解説する文章のまとめ方

機能を解説する文章のポイント／主語・主題の明示／「可能（機能）」の表現／いくつかの陥りやすい事例

製品の操作を解説する文章のまとめ方

複文形式による操作と操作結果のまとめ方／能動態と受動態の使い分け／陥りやすい事例


第5部取扱いマニュアルで扱う解説段落のまとめ方 ................................... （第 1 日・午後）

取扱いマニュアルを執筆する際には，「1 文単位ではなく段落の構成に着目する」ことが基本

です．また，実用的なマニュアルを作成するには，節見出しを受けた段落（節リード段落）で

的確に節の構成や目的を述べる必要があります．第 5 部では，段落をまとめる際の基本ととも

に，主題に応じた節リード段落，解説段落を構成する手法を解説します．

段落の構成とチェックポイント

主文－補足文構成／段落の適切な長さ／長い段落の扱い方／陥りやすい事例

節リード段落の考え方・まとめ方

節リード（要約）段落の重要性／節リード段落の分類／わかりやすい節リード段落の構成


4

解説段落の考え方・まとめ方

節リード段落の解説段落の関係／解説段落の主文と補足文／解説段落の例／陥りやすい事例


第6部取扱いマニュアルで扱う解説文のチェックポイント......................... （第 1 日・午後）

どのような文章も書いただけでは完成とはいえません．さまざまな視点で見直すことが必要

です．第 6 部では，取扱いマニュアルでしばしばわかりづらさ，誤解につながりやすいいくつ

かのポイントとその改善方法を事例で解説します．

あいまい表現のチェック

あいまいな語を使ったあいまい表現／情報の不足によるあいまい表現／あいまいな否定表現

冗長表現のチェック

語の重複によるあいまい表現／不適切な文構成によるあいまい表現／冗長にならない助詞の使い方

複文の使い方

マニュアルで使う複文の構成／いくつかの陥りやすい事例／「とき」と「場合」の使い分け

文末表現・ていねい表現の使い方

「です・ます調」，「である調」の使い分け／体言止めの使い方／いくつかの陥りやすい事例

箇条書きの使い方

箇条書きの基本ルール／陥りやすい事例／箇条書きの応用的な使い方

句点の使い方・読点の使い方

句点の使い方／読点の使い方／読点の使い方の例


プログラム（第 2 日）

第7部取扱いマニュアルの操作指示のまとめ方........................................... （第 2 日・午前）

ユーザにわかりやすく取扱い方法を解説することは，取扱いマニュアルでも最重要の課題と

いえます．第 7 部では，適切な操作指示文の表し方とこれを箇条書き形式で用いる際のポイン

トを解説します．あわせて，多くの製品で導入されている GUI（Graphical User Interface）による操作を示す際の指示文の表し方を事例で解説します．

操作指示文の使い方

操作指示文の構成／文末表現「します」と「してください」の選び方／複文形式の操作指示文の使い方

／操作指示文を主文にした段落の構成／いくつかの陥りやすい事例

箇条書き形式の操作指示

箇条書き形式の操作指示の基本／陥りやすい事例／箇条書き形式の番号書式／応用的な箇条書き形式

操作指示文と図の対応

逐次型の図の入れ方／一部省略型の図の入れ方／効果的な図との対応の付け方

GUI 表記を使う操作指示文の例

メニュー，ダイアログ類の表記／ボタン，ボックス類の表記／マウスによる操作の表記例／コマンドの実行

の表記／ボタンの操作の表記／ボックスへの入力の表記


5

操作指示文の応用－Q&A 形式

Q&A 形式の段落の構成／いくつか陥りやすい事例


第8部取扱いマニュアルの注意指示のまとめ方........................................... （第 2 日・午前）

取扱いマニュアルでは，ユーザに対してさまざまな注意を促す必要があります．第 8 部では，

取扱いマニュアルの中で「安全に関する注意事項」および「一般的な注意事項」を明確に示す

方法を解説します．

「安全に関する注意事項」のまとめ方

マニュアル中での表記／安全に関する注意指示の基本構成／応用的な注意指示の例

「一般的な注意事項」のまとめ方

マニュアル中での表記／一般的な注意指示の基本構成／応用的な注意指示の例

注意事項をわかりやすくするポイント

多項目をわかりやすく示す方法／図の使い方／注意指示のチェックポイント／陥りやすい事例


第9部取扱いマニュアルのレイアウトの手法 .............................................. （第 2 日・午後）

レイアウトの手法は適切に使うと読者の理解を助ける一方で，使い方を誤ると本質をはずし

た“レイアウト優先主義”に陥ったり，ときには製作コスト高につながりかねません．第 7 部

では，機能的でありかつワープロのレイアウト機能でも可能なレイアウトの手法を解説します．

ページのレイアウト

マニュアルのレイアウトとは／構図の基本／効果的な視線の誘導

書式のレイアウト－見出し－

見出しのレイアウトの例／陥りやすい事例／簡略型レイアウトの例

書式のレイアウト－本文と補足要素－

本文の字詰の取り方／書体の選び方／補足要素のレイアウト／図・表の入れ方／陥りやすい事例

判型と見出し書式・本文書式

判型に応じた余白のとり方／判型に応じた本文書式の決め方

応用的なレイアウトの手法

段組レイアウト／色・網かけの使い方／けい線の使い方／陥りやすい事例

レイアウトの補足知識

見開き構成の基本／ヘッダとページ番号の扱い方


第10部取扱いマニュアルの図・表のチャート化と図解の手法 ..................... （第 2 日・午後）

ビジュアル化（チャート，図解の導入）は，マニュアルの重要なポイントです．第 10 部で

は，構成図，操作図，段落をチャート化・図解化する手法を解説します．また，図・表を作成

する際の基本的なポイントを解説します．


6

構成図のチャート化

構成図をチャート化する際のポイント／陥りやすい事例／改善した事例

操作図のチャート化

操作図をチャート化する際のポイント／視線の誘導の手法／図の関連付けの手法

段落のチャート化

チャート図の基本／段落をチャート化する際のポイント／故障診断チャートの作成手法の例

図解の手法

「図解」とは／箇条書き形式を基にした図解の例／図の関連付けを基にした図解の例

図・表を構成する際の基本とポイント

本文と図・表中の用字用語・表記の統一／図の内容と大きさの関係／図・表説明の付け方

表の使い方

表の基本ルール／表の応用書式／表の工夫


第11部用字用語の使い方 ............................................................................... （第 2 日・午後）

取扱いマニュアルでは，わかりやすい用語を統一して使う必要があります．第 11 部では，取

扱いマニュアルを執筆する際の「用字用語（一般用語）」のより所と注意点を解説するとともに，

陥りやすい問題点，事例を解説します．

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

「常用漢字表」とは／使い分けの考え方／ひらがな書きが適当な例／漢字書きが適当な例／品詞・用法

による使い分け／用字用語リストの作り方

送り仮名の使い方

送り仮名の考え方／活用のない語の送り仮名／活用のある語の送り仮名／複合の語の送り仮名

外来語の表記－カタカナ表記を中心にして－

考慮が必要な外来語の取扱い／カタカナを表記する際の不統一の原因／外来音に対するカタカナ表

記の当て方／長音の扱い方／複合語の中点の扱い方／分野によるカタカナ表記の違いへの対応

意味が同じ語・似ている語の使い分け

マニュアルで使いやすい異字同訓語の例／マニュアルで使いやすい同音類義語の例


第12部取扱いマニュアルの技術用語の使い方 .............................................. （第 2 日・午後）

取扱いマニュアルでは，用字用語（一般用語）とともに技術用語（専門用語，固有名称）も

統一して使う必要があります．第 12 部では，取扱いマニュアルで陥りやすい技術用語の使い

方のポイントを解説します．また，取扱いマニュアルを執筆する際に使う編集用語や改訂の表

記の方法についても解説します．

技術用語の使い方とチェックポイント

専門用語のより所／用語の統一／類義表現のチェック／技術慣用表現のチェック／陥りやすい事例

マニュアルでの和語・漢語・外来語表現の使い分け

和語で表すか・漢語で表すか／漢語で表すか・外来語で表すか／外来語を使う際の注意


7

固有名称の使い方

固有名称の取扱いの基本／執筆者が定義する固有名称の扱い方

記号の用法

「囲み」記号の用法／括弧の効果的な使い方／「区切り」記号・「つなぎ」記号の用法

マニュアルで使う編集用語

製品を示す際の表記／マニュアルを指す際の表記／表紙の基本構成／改訂版数・改訂履歴の表記／

追補と改訂／著作権の表記


［重要］開催に伴う付帯事項

本セミナーは，その主旨から企業で研究，開発および製造などに従事され各種の取扱いマニ

ュアルを作成する機会がある技術者の方々を対象とした有料セミナーです．

セミナーの開催は開発・製造関連企業の主催により当方が出張で実施する方式を基本前提としています．

開催費用は，諸条件（場所，参加人数，その他）をお伺いしたうえで，見積り申し上げます．

本セミナーは，当社ホームページ「わかりやすいマニュアル作成のための実践テクニカルラ

イティングセミナー」と基盤になる考え方は同じにしていますが，実務知識と事例を中心とし

た新構成です．

当社ホームページに公開しているプレゼンスライドとの重複はおよそ 5％以下です．

［重要］本件に関するお問合せに際してのお願い

本件のお問合せに際しては，必ず企業名，ご所属，氏名，電話番号をお知らせください．ま

た，E メールはご所属企業によるご本人の E メールアドレスからご連絡ください．

企業名，ご所属，氏名，電話番号などがない匿名のお問合せには，ご返答を差し控えさせていただくことが

ありますのであらかじめご了承ください．

また，ご所属の企業ドメイン以外のメール（フリーメールあるいは一般のインターネットサービスプロバイダのメ

ールアドレスを使用したメール）に対してはご返答を差し控えさせていただくことがありますのであらかじめご

了承ください．

開催にあたっての具体的なご相談は原則として面談による打合せとさせていただくことをお

願いしています．

打合せの事前にプレビュー版などのファイルや印刷資料をお送りすることはしておりませんのであらかじめ

ご了承ください．

お問合せはこちらへ

有限会社山之内総合研究所山之内孝明

[email protected]

（以上）

本資料の引用・転載および本資料を原案とした二次著作物の作成を禁じます．© Yamanouchi Research Institute, Ltd. 2002

mailto:[email protected]

1

2002 年 11 月

テクニカルライティングで考えるわかりやすい技術文書の作成手法

-技術報告・研究報告編－




技術者の皆さんには，新しい技術や製品を研究・開発の結果を「報告文書」としてまとめる機

会がしばしばあるはずです．しかしその際に，いわゆる“論文スタイル”あるいは“報告書スタ

イル”の構成，文体にまとめあげることが先になり，報告を受ける相手には「形式は整っている

が内容がわかりにくい」，「結論（あるいは主題）がわかりづらい」という指摘を受けたことはな

いでしょうか．また，「プレゼンテーション形式の報告を作成するのに比べて文書でまとめるの

は難しい」と思われたことはないでしょうか．

わかりやすい報告文書作りには，文章のまとめ方や適切な用語の使い方とともに「読者の理解

に配慮した文書を作成する」ための具体的な手法を理解しておくことが必要になります．また，報告文

書を作成する際に陥りやすい問題点についても知っておかなければなりません．

本セミナーでは，技術報告，研究報告あるいは学術論文を作成する場合を想定し，テクニカル

ライティング（技術文書の作成手法）の視点から，全体構成と段落構成の考え方，文章の書き方，

用語の使い方，図・表の作り方の基本とそれぞれのチェックポイントを事例で解説します．

セミナー実施方法と概略構成


対象者技術報告書，研究論文を作成する機会の多い技術者および文書管理担当者




（序部）わかりやすい技術報告・研究報告へのアプローチ

第 1 部目次構成の考え方

午前の部

第 2 部段落構成の考え方・まとめ方

第 3 部文章のまとめ方

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

第 5 部図・表作成のポイントと本文との対応付け

第 6 部用字用語の使い方

第 7 部技術用語の使い方

午後の部

補足ワープロで文書を作成する際のいくつかのルール



開催概要

セミナー開催概要－テクニカルライティングで考えるわかりやすい技術文書の作成手法＜技術報告・研究報告編＞－

2

プログラム

（序部）わかりやすい技術報告・研究報告へのアプローチ

技術文書における「技術報告」，「研究報告」の考え方，陥りやすい問題点をあげるとともに，

テクニカルライティングの考え方を示します．

技術文書の目的と読者対象／学術論文と技術報告・研究報告／技術文書のキーワード／「テクニカルラ

イティング」とは／本セミナーの構成


第1部目次構成の作り方

技術文書作りの第一歩は，目次構成（文書の構成）を考えることです．第 1 部では，「章」・「節」・

「項」による目次構成の考え方と「見出し番号」，「見出し名」の付け方について解説します．



見出し番号書式の意味／誤解されやすい見出し番号書式／ページ数の多い文書の見出し番号書式

章構成の考え方と見出し名の付け方

「主題-結論型」章構成の考え方／目次要素の書出し／ページ数・見出し名の調整

節構成・項構成の考え方と見出し名の付け方

複雑な節構成を調整する方法／節見出し名の付け方／項構成の考え方／項構成で陥りやすい事例／

項見出し名の付け方／陥りやすい見出し名（あいまいな見出し名・冗長な見出し名）


第2部段落構成の考え方・まとめ方

わかりやすい報告文書であるためには「見出しの構成（目次構成）」と「段落構成」が明解

でなければなりません．主題と結論が明確な段落構成を考える方法を解説します．

段落構成の考え方

「段落構成」とは／陥りやすい事例／報告文書の段落構成／「主題」から段落を構成する方法／「結論」

から段落を構成する方法／図・表を解説する段落構成／段落構成をわかりやすくする方法


箇条書きの基本ルール／理解しづらい箇条書き

「緒言」の段落構成

明確に要旨・結果を述べる緒言の構成／陥りやすい事例

「章リード段落」・「節リード段落」の段落構成

章リード段落の例／節リード段落の例／陥りやすい事例


第3部文章のまとめ方

報告文書で使う文章を「報告者・読者が主語になる文」，「事実・結果が主語になる文」に類型


3

し，そのポイントを解説します．また，報告文書でよく使われる「複文（主節－従節構造）」の

適切な使い方について事例で解説します．

「報告者・執筆者」が主語になる文

現在形と過去形の使い分け／断定・受身・推量の表現の使い分け／能動態と受動態の使い分け／陥り

やすい事例

「事実・結果」が主語になる文

主語と主題の考え方／能動態と受動態の使い分け／陥りやすい事例

複文の基本

複文の構成／能動態と受動態の使い分け

段落をまとめる際のチェックポイント

見出しとの対応付け／段落の長さ・文章の長さ／陥りやすい事例／脚注・注の使い方／長い補足段落

の取扱い

句読点の使い方



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

わかりやすい文章を書くためには，「書くだけではなく見直す」ことが欠かせません．第 4 部

では，報告文書の文章表現で陥りやすい問題点，事例をあげその具体的な対処方法を解説します．


あいまいな語を使う文章／情報不足によるあいまい表現／主語・修飾語があいまいな文章／あいまいな

否定文


意味に影響しない語・重複した語による冗長表現／不適切な文章構成が原因の冗長表現／形式名詞

を使う冗長表現

技術文書で陥りやすい表現のチェック

誤解されやすい表現／対応の悪い表現／技術慣用表現／通俗的な表現／ていねいすぎる表現

修飾語の使い方

修飾語の使い方の基本／一つの語に複数の修飾語がかかる場合の扱い方

複文の使い方

わかりづらい複文の直し方／陥りやすい事例／「－とき」と「－場合」の使い方

文末表現の使い方

「－である」調，「－です，ます」調，体言止めの使い分け／「－である」調文末表現の注意


第5部図・表作成のポイントと本文との対応付け

報告文書において図・表は，単体でも内容が理解できるとともに本文とも適切に対応している

必要があります．第 5 部では，図・表を理解しやすくするためのさまざまな手法を事例で解説し


4

ます．あわせて本文と図の対応をよくする工夫を解説します．

図・表を作成する際のポイント

図の基本書式（グラフ・特性図・ブロック図）／表の基本書式と応用書式

わかりやすい図・表を作成する工夫

図・表のわかりにくさの原因／図・表中への情報の補足／要点への視線の誘導／要点の関連付けの手

法／複雑すぎる図の直し方／陥りやすい事例

図と本文の対応の工夫

「簡単すぎる本文，詳しすぎる図の関係」のチェック／本文の「主題」に応じた図の使い方／本文と図・表

中の用語・表記の統一


第6部用字用語の使い方

報告文書のみならず技術文書では，一般用語，専門用語を問わず適切な用語を統一して使う必

要があります．第 6 部では，「用字用語」を使う際のより所と注意点を解説するとともに，技術

文書で陥りやすい問題点を事例で解説します．

用字用語の基本

用字用語とは／用字用語のより所／陥りやすい用字用語の課題

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

常用漢字表とは／ひらがな書きが適当な例／漢字書きが適当な例／用法によって使い分けが必要な例

／用字用語リストの作り方


不統一になりやすい送り仮名（活用のない語・活用のある語）／複合の語の送り仮名の付け方

外来語のカタカナ表記の使い方

カタカナ表記する際の不統一のポイント／カタカナ表記の当て方／長音の扱い方／分かち書き（複合

語）の中点の扱い方


技術文書でよく使う「異字同訓語」の例／技術文書でよく使う「同音類義語」の例


第7部技術用語の使い方

第 7 部では，「技術用語」を使う際の基本とで陥りやすい問題点を事例で解説します．

専門用語，固有名詞の使い方

専門用語のより所／固有名詞および略称・略号の使い方

技術用語を使う際の注意

用語の表記と意味の統一／キーワードの使い方／複合語・短縮語を使う際の注意／類語・同義語／陥

りやすい事例

和語・漢語・外来語の使い分け



5

記号の使い方

囲み記号の使い方／括弧の使い方／区切り記号・つなぎ記号の使い方／単位，単位記号，量記号


補足ワープロで文書を作成する際のいくつかのルール

当セミナーの補足として，文書レイアウトの基本とワープロで文書を作成する際に注意するポ

イントを解説します．

書式のレイアウト

本文書式の原則／書体の選び方／左右字詰めの決め方／明朝体とゴシック体の使い方

見出し・ページのレイアウト

見出し書式の考え方／文書の見開き構成／ヘッダとページ番号の扱い方

図・表のレイアウト

図・表の挿入位置の原則／図・表の割り組配置・左右配置をする際の注意



本セミナーは，その主旨から企業で研究・開発および製造などに従事され，各種の技術文書を

作成する機会がある技術者の方々を対象とした有料セミナーです．



本セミナーは，当社ホームページ「わかりやすいマニュアル作成のための実践テクニカルライ

ティングセミナー」と基盤になる考え方は同じにしていますが，技術報告・研究報告文書をテー

マとし実務知識と事例を中心にした新構成です．



本件のお問合せに際しては，必ず企業名，ご所属，氏名，電話番号をお知らせください．また，

E メールはご所属企業によるご本人の E メールアドレスからご連絡ください．



また，ご所属の企業ドメイン以外のメール（フリーメールあるいは一般のインターネットサービスプロバイダの

メールアドレスを使用したメール）に対してはご返答を差し控えさせていただくことがありますのであらかじめ







6


有限会社山之内総合研究所山之内孝明 [email protected]

（以上）本資料の引用・転載および本資料を原案とした二次著作物の作成を禁じます．© Yamanouchi Research Institute, Ltd. 2002


1

2002 年 11 月

テクニカルライティングで考えるわかりやすい技術文書の作成手法

-製品解説・技術解説編－




技術者の皆さんには，新しい技術や製品を研究・開発するだけではなくこれらを社内や社外に

向けて「文書で解説する」機会がしばしばあるはずです．その一方で，作成した技術文書やマニ

ュアルに対して「内容がわかりにくい」という指摘を受け，どのように技術文書作りを進めれば

よいかわからないと思われることはないでしょうか．また，「プレゼンテーションスライドの作

成に比べて文書でまとめるのは難しい」と思われたことはないでしょうか．

わかりやすい技術文書作りには，文章のまとめ方や適切な用語の使い方とともに「読者の理解

に配慮した文書を作成する」ための具体的な手法を理解しておくことが必要になります．また，技術文

書を作成する際に陥りやすい問題点についても知っておかなければなりません．

本セミナーでは，製品解説文書，製品仕様書，技術解説文書を作成する場合を想定し，テクニ

カルライティング（技術文書の作成手法）の視点から，全体構成と段落構成の考え方，文章の書

き方，用語の使い方，図・表の作り方の基本とそれぞれのチェックポイントを事例で解説します．

セミナー実施方法と概略構成


対象者製品解説，製品仕様書，技術解説を作成する機会の多い技術者

文書管理担当者




（序部）わかりやすい製品解説・技術解説へのアプローチ

第 1 部目次構成の考え方

第 2 部見出し名の付け方

午前の部

第 3 部解説文のまとめ方

第 4 部解説段落のまとめ方

第 5 部解説文のチェックポイント

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

第 7 部用字用語の使い方

第 8 部技術用語の使い方

午後の部

補足文書中の各種表記の基本ルール



開催概要

セミナー開催概要－テクニカルライティングで考えるわかりやすい技術文書の作成手法＜製品解説・技術解説編＞－

2

プログラム

（序部）わかりやすい製品解説・技術解説へのアプローチ

技術文書における「製品解説」，「技術解説」の位置付け・考え方，陥りやすい問題点をあげる

とともに，テクニカルライティングの考え方を示します．

技術文書の目的と読者対象／執筆者と読者の関係／執筆者に求められるもの／「テクニカルライティン

グ」とは／本セミナーの構成


第1部目次構成の考え方

技術文書作りの第一歩は，目次構成（文書の構成）を考えることです．第 1 部では，「見出し

番号」の付け方に始まり，「章」・「節」・「項」による目次構成の考え方について解説します．



論文型見出し番号書式とマニュアル型見出し番号書式／誤解されやすい見出し番号書式／ページ数

の多い文書の見出し番号書式

全体コンセプトと章構成の考え方

メーカの論理とユーザの論理／製品解説・技術解説文書の章構成／製品仕様書の章構成

節構成の考え方

節構成の意味と基本／陥りやすい事例／複雑な節構成の調整方法／ページ数が多い文書の節構成

項構成の考え方

項構成の意味と基本／陥りやすい事例／項構成の調整法


第2部見出し名の付け方

文書を初めて読む読者，機能の名称を初めて知る読者にとって，わかりやすい見出し名は文書

の内容・構成を知るための「道標」になります．第 2 部では，製品解説・技術解説文書でよく使

う見出し名の適切な使い方について解説します．

製品解説文書の見出し名

技術文書で使う見出し名の類型／見出し名を付ける際のポイントと基本

見出し名をわかりやすくする手法

章見出し名の手法／節見出し名の手法／項見出し名の手法

注意して使う見出し名

あいまいな見出し名／冗長な見出し名


第3部解説文のまとめ方

製品を解説する文書では，「製品，文書に関連する事項が主語になる文」，「執筆者あるいはユ


3

ーザが“省略された主語”になる文」，さらには「異なる主語で構成される複文」などさまざま

な文章が使われます．第 3 部では，これらを分類して示しそれぞれのポイントを解説します．

技術文書で使う文章の考え方

技術文書で使う文章の便宜的分類

執筆者が主語になる文章のまとめ方

定義・命名する文章／文書の内容を告知する文章／製品に関連する事項を告知する文章

製品・文書の「構成」を解説する文章のまとめ方

製品の構成を解説する文章／文書の構成を解説する文章／能動態と受動態の使い分け

製品の「機能」を解説する文章のまとめ方

機能を解説する文章のポイント／主語・主題の明示／「可能（機能）」の表現／陥りやすい事例

製品の「操作」を解説する文章のまとめ方

複文形式による操作と操作結果のまとめ方／能動態と受動態の使い分け／陥りやすい事例


第4部解説段落のまとめ方

技術文書を執筆する際は，「1 文単位ではなく段落の構成に着目する」ことが基本です．第 4部では，段落をまとめる際の基本とともに，主題に応じた節リード段落，わかりやすい解説段落

を構成する手法，さらには段落と図との対応について解説します．

段落の基本ポイント

文書の構成と段落の関係／主文－補足文構成／段落の適切な長さ／長い段落の扱い方／陥りやすい

事例／注の使い方／長い補足の取扱い

リード段落の考え方・まとめ方

リード段落の意味と類型／リード段落のポイントと例

解説段落の考え方・まとめ方

解説段落の主文と補足文／主文のタイプによる解説段落の例／陥りやすい事例

解説段落と図の対応の工夫

「簡単すぎる本文，詳しすぎる図の関係」のチェック／図との対応をよくするいくつかの工夫


第5部解説文のチェックポイント

わかりやすい文章を書くためには，「書くだけではなく見直す」ことが欠かせません．第 5 部

では，製品解説・技術解説文書で陥りやすい問題点，事例をあげその具体的な対処方法を解説し

ます．


あいまいな語を使う文章／情報不足によるあいまい表現／目的語・修飾語があいまいな文章／あいまい

な否定文


4


意味に影響しない語・重複した語による冗長表現／不適切な構成が原因の冗長表現／形式名詞を使う

冗長表現／助詞の使い方が原因の冗長表現

複文の使い方

複文と重文／わかりづらい複文の直し方／陥りやすい事例／「－とき」と「－場合」の使い方

文末表現・ていねい表現の使い方

「－である」調，「－です，ます」調，体言止めの使い分け／ていねい表現の適切な使い方


箇条書きの基本ルール／理解しづらい箇条書き／箇条書きの応用

技術文書で陥りやすい表現のチェック

誤解されやすい表現／対応の悪い表現／技術慣用表現／通俗的な表現／ていねいすぎる表現

句読点の使い方



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

第 6 部では，図・表を理解しやすくするためのさまざまな手法を事例で解説します．あわせて

文書を完成させるために必要なレイアウトの手法を解説します．

図・表を作成する際の基本とポイント

線・文字の選び方／用語・表記の統一／図・表説明の付け方

構成図の作成手法

わかりやすい構成図のポイント／陥りやすい事例／図・表中への情報の補足／要点への視線の誘導

ブロック図・チャート図の作成手法

ブロック図・チャート図の基本書式／陥りやすい事例／複雑すぎるブロック図の直し方／チャート図を作

成する際のポイント

図・表の関連付けの手法

図と図の関連付け／図と表の関連付け

表の作成手法

表の基本ルール／表をわかりやすくする工夫

書式のレイアウト

本文書式の原則／書体の選び方／左右字詰めの決め方／明朝体とゴシック体の使い方

見出し・ページのレイアウト

見出し書式の考え方／文書の見開き構成／ヘッダとページ番号の扱い方

図・表のレイアウト

図・表の挿入位置の原則／図・表の割り組配置・左右配置をする際の注意



5

第7部用字用語の使い方

技術文書では，一般用語，専門用語を問わず適切な用語を統一して使う必要があります．第 7部では，「用字用語」を使う際のより所と注意点を解説します．

用字用語の基本

用字用語とは／用字用語のより所／陥りやすい用字用語の課題

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

常用漢字表とは／ひらがな書きが適当な例／漢字書きが適当な例／用法によって使い分けが必要な例

／用字用語リストの作り方


不統一になりやすい送り仮名（活用のない語・活用のある語）／複合の語の送り仮名の付け方

外来語のカタカナ表記の使い方

カタカナ表記する際の不統一のポイント／カタカナ表記の当て方／長音の扱い方／分かち書き（複合

語）の中点の扱い方


技術文書でよく使う「異字同訓語」の例／技術文書でよく使う「同音類義語」の例


第8部技術用語の使い方

第 8 部では，「技術用語」を使う際の基本とで陥りやすい問題点を事例で解説します．

技術用語を使う際の注意

専門用語のより所／用語の表記と意味の統一／キーワードの使い方／複合語・短縮語を使う際の注意

／陥りやすい事例

和語・漢語・外来語の使い分け


固有名詞の使い方

固有名詞および略称・略号の使い方／執筆者が定義する固有名称の使い方

記号の使い方

囲み記号の使い方／括弧の使い方／区切り記号・つなぎ記号の使い方／単位，単位記号，量記号


補足文書中の各種表記の基本ルール

当セミナーの補足として，文書レイアウトの基本とワープロで原稿を作成する際に注意するポ

イントを解説します．

製品を示す際の表記／文書の別部分を指す際の表記／表紙の表記／改訂版数・改訂履歴の表記／

追補と改訂／著作権の表記



6


本セミナーは，その主旨から企業で研究・開発および製造などに従事され，各種の技術文書を

作成する機会がある技術者の方々を対象とした有料セミナーです．



本セミナーは，当社ホームページ「わかりやすいマニュアル作成のための実践テクニカルライ

ティングセミナー」と基盤になる考え方は同じにしていますが，製品解説文書，製品仕様書，技

術解説文書をテーマとし実務知識と事例による新構成です．



本件のお問合せに際しては，必ず企業名，ご所属，氏名，電話番号をお知らせください．また，

E メールはご所属企業によるご本人の E メールアドレスからご連絡ください．



また，ご所属の企業ドメイン以外のメール（フリーメールあるいは一般のインターネットサービスプロバイダの

メールアドレスを使用したメール）に対してはご返答を差し控えさせていただくことがありますのであらかじめ







有限会社山之内総合研究所山之内孝明 [email protected]

（以上）本資料の引用・転載および本資料を原案とした二次著作物の作成を禁じます．© Yamanouchi Research Institute, Ltd. 2002


Documents

わかりやすいマニュアル作成のための 実践テクニカルライティン … · イル，PDFファイル）を各種の文書作成の参考にしていただくこと

わかりやすいマニュアル作成のための実践テクニカルライティン … · イル，PDFファイル）を各種の文書作成の参考にしていただくこと