タイトル一覧
各タイトルは、左端のリンクから閲覧できます。
グループ1 見出し構成の考え方、見出し名の付け方
「見出し構成」は、文書の骨格です。「見出し名」は、段落の主題です。いずれも、文書作成の基本に関わります。技術文書の作成は、見出し構成の検討から始まります。
1-1 「見出し構成」とは
1-2 見出し構成の「原則」
1-3 「見出し番号書式」の選び方
1-4 見出し構成の工夫:下位の見出しの「繰り上げ」
1-5 見出し構成の工夫:「改ページ」の活用
1-6 「ページ数が少ない技術文書」の見出し構成
1-7 「数十ページ規模の技術文書」の見出し構成
1-8 「ページ数が多い技術文書」の見出し構
1-9 見出し構成のチェック:「見出しの上位・下位の原則」からの逸脱
1-10 見出し構成のチェック:一貫性を欠いた見出し書式
1-11 見出し構成のチェック:ページ数および項目数の偏り
1-12 見出し構成のチェック:見出しと箇条書きの混同
1-13 見出し構成のチェック:見出しの細分
1-14 技術文書の表題-基本形-
1-15 技術文書の表題-応用形-
1-16 技術文書の見出し名-基本形-
1-17 技術文書の見出し名-応用形-
1-18 見出し名の工夫:サブタイトルの活用
1-19 見出し名のチェック:「上位・下位」および「同位」の関係の原則
1-20 見出し名のチェック:単純語・複合語の見出し名への偏重
1-21 見出し名のチェック:論点が定まりづらい見出し名
1-22 見出し名のチェック:冗長な見出し名
グル―プ2 段落の表し方
要点は、段落の最初に置くのが基本です。要点とは、その段落で中心になる事項です。段落の最初に要点があると、読者は見出しが示す主題の答えが得られます。
2-1 「要点が明確な段落」とは
2-2 「要点が明確な段落」の表し方
2-3 技術文書での「段落の長さ」
2-4 技術文書での「文の長さ」
2-5 「1段落」構成と「複数段落」構成の使い分け
2-6 「起承転結」の有効な使い方
2-7 段落の視覚化
2-8 見出しと段落の対応
グル―プ3 文の表し方-主として単文-
単文とは、主語と述語の対応が一つの文です。主語と述語は、対になって「文の骨格」を形成します。主語が欠落していたり主語が的確に述語に係っていなかったりすると、文意が正しく伝わらないおそれがあります。
3-1 技術文書の文体
3-2 「文の主題」の扱い方
3-3 「は」と「が」の使い分け
3-4 主語と述語の対応
3-5 自動詞・他動詞・自他動詞の扱い方
3-6 受身文・使役文の扱い方
3-7 試験・調査の「目的」を表す文
3-8 「原因」を表す文と「理由」を表す文
3-9 「製品の動作・機能」を表す際の留意事項
3-10 「システムの動作・機能」を表す際の留意事項
3-11 文末表現の使い分け
3-12 敬語表現の基本
グル―プ4 文の表し方-主として複文-
「複文」とは、主語と述語の対応が複数ある文です。複文を使うと、単文では表しきれない事実関係を端的に表せます。一方で、主語と述語の対応をいくつも連ねると、要点がはっきりしない文になります。
4-1 目的語と述語の対応
4-2 補語と述語の対応
4-3 補語に付く格助詞の選び方
4-4 形容動詞の使い方
4-5 「程度」を表す副詞の使い方
4-6 「全部」を表す副詞の使い方
4-7 複合格助詞の使い方
4-8 複文を使う際の基本
4-9 「並列・継起」を表す複文と「手段・付帯」を表す複文
4-10 「条件と結果の関係」を表す複文
4-11 「目的」を表す複文
4-12 「原因・理由・根拠」を表す複文
4-13 「対比」を表す複文
4-14 「逆接」を表す複文
4-15 複文の添削:順接の「が」を伴った複文
4-16 複文の添削:「ため」が連なる複文
4-17 複文の添削:節が「入れ子」になった複文
グル―プ5 名詞修飾の使い方
修飾語あるいは名詞修飾節が名詞に係ってなんらかの意味的な限定を加えることを「名詞修飾」と総称します。名詞修飾によって被修飾語に係る「何の」や「どのような」などがはっきりします。一方で、名詞修飾を連ねると、その係り先が曖昧になる場合があります。
5-1 連体助詞「の」を使った名詞修飾の基本
5-2 連体助詞「の」を使う際の留意事項
5-3 名詞修飾節を使う際の基本
5-4 名詞修飾節を使う際の留意事項
5-5 名詞、名詞句および節を列挙する際の基本
グル―プ6 箇条書きの使い方
箇条書きは、「要点の具体的な内訳」です。箇条書きを単に文頭記号あるいは文頭番号を付けて文などを書き表す手法と解釈すると、箇条書きの利点を生かしきれません。
6-1 箇条書きの表し方
6-2 箇条書きの有効な使い方
6-3 箇条書きの表し方の統一
6-4 陥りやすい事例:主文が欠落した箇条書き
6-5 陥りやすい事例:階層式の箇条書き
グル―プ7 副本文・注記の使い方
副本文とは、「*」などの文頭記号を伴って段落の下に置く「添書き」です。注記とは、「重要」などの文頭語を伴って段落の下に置く「ただし書き」です。いずれも、段落に補足が必要な際に有効です。一方で、多用すると、副本文あるいは注記が段落より目立ってわずらわしくなります。
7-1 段落を補足する書式:副本文
7-2 段落を補足する書式:注記
グル―プ8 表の使い方
行で表す箇条書きに対して、行と列で構成する表は箇条書きの派生形と言えます。表を使うと、箇条書きでは表しきれない「条件と結果」の関係や「対比」の関係などを見やすく示せます。
8-1 表の作り方・使い方
8-2 表を使った「条件と結果」および「対比」
グル―プ9 図の使い方
「図にすればなんでもわかりやすい」として図に偏重するのは、本来の使い方ではありません。図は、段落の要点である「主文」に応じて使うのが基本です。
9-1 図を使う際の基本
9-2 図の有効な使い方
9-3 図を見やすくする工夫
グル―プ10 書式の選び方
技術文書をワープロで作成する際は、見出しや段落などの書式を適切に決める必要があります。文を的確に表していても、段落の行間が過度に狭いと読みづらくなります。
10-1 ページの書式
10-2 段落の書式
10-3 見出しの書式
10-4 副本文および注記の書式
10-5 箇条書きの書式
10-6 表の書式
10-7 図の書式
10-8 図・表の置き方
10-9 「ページ末の空き」と「行のはみ出し」の調整
10-10 「前付け」と「後付け」の扱い方
グル―プ11 文の直し方
技術文書を作成したら、必ず見直さなくてはなりません。「内容が正確であるか」だけでなく、「文の表し方が的確であるか」にも目を向ける必要があります。
11-1 技術文書の見直し方-技術文書チェックリスト-
11-2 用語のチェック:用語のゆれ
11-3 用語のチェック:語がいくつも連なった複合語
11-4 用語のチェック:複合語の動詞使い・形容動詞使い
11-5 用語のチェック:無理がある造語
11-6 用語のチェック:名称であることが曖昧な複合語
11-7 用語のチェック:必要以上の漢語・外来語
11-8 用語のチェック:無理がある慣用語・慣用表記
11-9 技術文書にそぐわない表現の見直し
11-10 曖昧表現のチェック:「程度」や「違い」などが曖昧な表現
11-11 曖昧表現のチェック:指示語の多用
11-12 曖昧表現のチェック:形式名詞の多用
11-13 曖昧表現のチェック:主語の欠落
11-14 曖昧表現のチェック:目的語の欠落
11-15 曖昧表現のチェック:補語の欠落
11-16 曖昧表現のチェック:名詞修飾のもれ
11-17 曖昧表現のチェック:曖昧な否定
11-18 冗長表現のチェック:語意の重複
11-19 冗長表現のチェック:係りと受けの重複
11-20 冗長表現のチェック:「において」や「について」などの多用
11-21 冗長表現のチェック:形式名詞の多用
11-22 冗長表現のチェック:連体助詞「の」の重ね使い
11-23 接続詞類のチェック:並列性を欠いた列挙
11-24 接続詞類のチェック:名詞修飾の係り先が曖昧な列挙
11-25 敬語表現のチェック:不自然な敬語
11-26 敬語表現のチェック:敬意を欠いた社外メール
11-27 敬語表現のチェック:誠意を欠いたお詫び状
グル―プ12 句読点および記号の使い方
句読点および記号の使い方が自己流になっていないかも見直す必要があります。語の係り先を示唆するような読点の使い方は、かえって読者の誤解を招きかねません。また、括弧書きの多用は文を読みづらくします。
12-1 読点を使う際の基本
12-2 読点の要否を迷いやすい箇所
12-3 無理が生じやすい読点:目的語への付与
12-4 無理が生じやすい読点:補語への付与
12-5 無理が生じやすい読点:名詞修飾節への付与
12-6 無理が生じやすい読点:語を列挙する接続詞・並列助詞への付与
12-7 無理が生じやすい読点:構成に難がある複文への付与
12-8 句点の使い方
12-9 括弧の使い方
12-10 「つなぎ記号」および「区切り記号」の使い方
グル―プ13 用字用語の選び方
用字用語には、『常用漢字表』をはじめとしていくつかよりどころがあります。文意に関係しないとして用字用語を不統一にすると、技術文書の品質を損ないます。
13-1 用字用語:漢字書きと平仮名書きの使い分け
13-2 用字用語:送り仮名の付け方
13-3 用字用語:外来語の片仮名表記
グル―プ14 報告書の書き方
試験報告書をはじめとして、企業での報告書は定型化される傾向があります。一方で、定型化によって重要事項が下位の見出しに埋もれている例も多々あります。上位が定型の見出しであっても、下位の見出しを付けて報告すべき事項を的確に表す必要があります。
14-1 試験報告書:見出し構成の考え方
14-2 試験報告書:「表題」、「目的」および「対象・方法」の表し方
14-3 試験報告書:「結果」、「考察」および「結論」の表し方
14-4 「不具合の原因と対策」の表し方
14-5 「検証・検討報告書」および「成果報告書」の見出し構成
14-6 調査報告書:「表題」、「緒言」および「要旨」の表し方
14-7 調査報告書:見出し構成の考え方
グル―プ15 報告書の事例
報告の目的を述べる際に前置きを連ねると、「何を達成しようとしているか」が曖昧になります。不具合の原因を述べる際に経過を主体にすると、「何によってそれが起こったのか」が曖昧になります。どのような案件であっても、企業の報告書は要点が明確でなくてはなりません。
15-1 報告書:不具合の原因解明
15-2 不具合の原因と対策-第1章を「事象」にした例-
15-3 不具合の原因と対策-第1章を「目的」にした例-
15-4 不具合の原因と再発防止策-「考察」を加えた例-
15-5 不具合の原因と再発防止策-問題が重なった例-
15-6 納入先へのお詫びを伴う報告書
15-7 報告書:顧客への不具合の通知
グル―プ16 各種の文書の表し方-議事録、技術解説-
議事録は、決定事項が明確でなくてはなりません。技術解説は、その技術がどのようなものであるかが明確でなくてはなりません。
16-1 議事録の構成
16-2 議事録の文体
16-3 技術解説の表し方
グル―プ17 取扱いマニュアルの作り方
一般ユーザー向けの製品であれ産業用途の製品であれ、取扱いマニュアルは「読者が知りたい事項」あるいは「読者が知るべき事項」が見つけやすい見出し構成にする必要があります。また、「手順」の表し方は全章を通して統一されていなくてはなりません。
17-1 取扱いマニュアル:見出し構成の考え方
17-2 取扱いマニュアル:「取扱い手順を述べる項目」の表し方
17-3 取扱いマニュアル:「取扱い手順」の表し方
17-4 取扱いマニュアル:「取扱い手順」を表す際の工夫
17-5 取扱いマニュアル:「注意喚起」の表し方
グル―プ18 システム操作マニュアルの作り方
システム操作マニュアルでは、見出し名が画面やメニューなどの名称になりがちです。その結果、内容が機能の説明に偏った「メーカーの視点」に陥りやすくなります。「製品をどのように使ってゆくのか」といった「ユーザーの視点」からシステム操作マニュアルを発想する必要があります。
18-1 システム操作マニュアル:見出し構成の考え方-段階的に作業を進める使い方の製品-
18-2 システム操作マニュアル:見出し構成の考え方-操作モードを選んで使う製品-
18-3 システム操作マニュアル:「操作手順を述べる項目」を表す際の基本
18-4 システム操作マニュアル:「操作手順」と「注意喚起」の表し方
18-5 システム操作マニュアル:「操作手順」の書式
グル―プ19 ビジネス業務マニュアルの作り方
ビジネス業務マニュアルは、業務の実態に即した見出し構成にする必要があります。また、「担当者が達成すべき事項」が明確でなければなりません。
19-1 ビジネス業務マニュアル:見出し構成の考え方
19-2 ビジネス業務マニュアル:「業務の内容」と「業務の手順」の表し方
グル―プ20 作業手順書の作り方
作業手順書には、「必要な項目」が見つけやすくかつ「作業の構成」がわかりやすい見出し構成が求められます。また、「何をするか」とともに「何をしてはならないか」が的確な文で示されている必要があります。
20-1 作業手順書:見出し構成の考え方
20-2 作業手順書:「作業手順」の表し方
20-3 作業手順書:書式の決め方
コメント
コメントを投稿