技術文書の書き方

　ここでの「見出し番号」とは、見出しの先頭に付いて同位の順序と上位・下位の関係を表す番号です。なお、アルファベットなどの順序性を伴う文字も、便宜的に見出し番号と扱います。 見出しが「 2-1 　専用ドライバのインストール」とあった場合 　　 2-1 　･･･　見出し番号　 　　専用ドライバのインストール　･･･　見出し名　 　見出し番号の書式（以下、「見出し番号書式」と表記）には、同じ見出し階層でも「第 1 章」や「 1. 」といったいくつかの形があります。同時に、見出し番号書式にはそれぞれの意味があります。 今回は、技術文書にはどのような見出し番号書式が適しているのかを中心に述べてゆきます。見出し番号書式の選び方によっては、見出しの上位・下位および同位の関係がわかりづらくなる場合があります。 1.　 「技術文書に定着した見出し番号書式」を選ぶ意味 2. 　 見出し番号書式の「原則」 3. 　 技術文書で使われる見出し番号書式 4.　 「階層固定型」の見出し番号書式の使い方 5.　 「階層固定型」の見出し番号書式を使う際の留意事項 6. 　 ページ数が多い技術文書での「階層固定型」の見出し番号書式 7.　 「枝番号型」の見出し番号書式を控えるべきとする理由 8.　 「全部・一部省略型」の見出し番号書式を控えるべきとする理由 9. 　 「一部記号型」の見出し番号書式を控えるべきとする理由 10. 　 見出し番号を付ける際の留意事項 11.　 見出し番号の表し方 12.　 参照先の示し方 まとめ 後　記 © Yamanouchi Takaaki 2024 ［注］今回のテーマは他の回と関わる部分が多いため、以前に解説した内容と重複する箇所があります。 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全24ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文を PDF ファイルにして概要・目次に添付しました。 HTML 形式ではワープロ文書の表し方を解説しきれないというのがその理由です。 l 　 PD...

　 技術文書をワープロで作成する際は、見出し、段落、図・表などの書式を適切に決める必要があります。 最初に決めるのは、見出しでもなく段落でもなく「ページ」に関する書式です。 ここでの「書式」　　　　         　  技術文書を作成する際のワープロの設定 ここでの「ページの書式」　　　 判型、余白、ページ番号、ヘッダーといったページ全体に関わる書式　 　今回は、読者にとって見やすいページの書式を解説してゆきます。段落や見出しなどの書式は、それぞれの回で解説します。 1.      書式の決め方 2.      判型の選び方・使い方 3.      ページの余白の決め方・使い方 4.      ページ番号の付け方 5.      陥りやすい事例：「章通し型」のページ番号 6.      ヘッダーの付け方 7.      陥りやすい事例： 　 ヘッダーの「見出し」扱い まとめ 後　記　 © Yamanouchi Takaaki 2024 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全19ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文を PDF ファイルにして概要・目次に添付しました。 HTML 形式ではワープロ文書の表し方を解説しきれないというのがその理由です。 l 　 PDF ファイルは、 5MB 以内です。使用する閲覧ソフトウェアによって表示の細部が若干異なる場合があります。 l 　 PDF ファイルの利用は、閲覧のみです。共有やダウンロードなどのご要...

　 文字の書体・大きさをはじめとして段落の行間などの細かな設定も、文書全体の読みやすさに関わります。見出しや注記なども、段落の書式が基盤です。 文字の書体・大きさ、 1 行の字数、行間、段落の始まりの字下げ、段落の間隔、折り返し時の行末の処理、その他 　今回は、段落の書式の適切な選び方を解説してゆきます。 1.      読みやすさにつながる書式 2.      書体の選び方 3.      「全角」と「半角」の使い分け 4.      「文字の大きさ」の選び方 5.      「 1 行の字数」の設定 6.      「行間」の設定 7.      陥りやすい事例：行間が狭い段落 8.      「段落の間隔」の扱い方 9.      「 1 字下げ改行」の扱い方 10.   　 「 1 字下げ改行」が少なくなった理由 11.   　 「折り返し時の行末」の扱い方 12.  　  陥りやすい事例：不自然な改行 13.   　 「字空け」の使い方 まとめ 後　記　 © Yamanouchi Takaaki 2024 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全27ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文を PDF ファイルにして概要・目次に添付しました。 HTML 形式ではワープロ文書の表し方を解説しきれないというのがその理由です。 l 　 PDF ファイ...

　技術文書においても、「見出し」は重要です。もっとも重要であると言ってよいくらいです。読者は、見出しによって「知りたい事項」あるいは「知るべき事項」を見つけます。 文書での「見出し」　　　　段落の主題であって、階層を構成してその文書の骨格を成す。 　見出しは、文書から必要な事項を見つけて答えを得るための道しるべです。 語としての「見出し」　　　見いだす（見つける）ことあるいは見出す（見始める）こと 見出しは、上位から章、節、項、目の順で階層を成します。それぞれが見つけやすく一目で見出しの上位と下位がわかる書式が適切です。 　今回は、ページ規模に応じた見出しの書式の選び方を中心にして解説してゆきます。あわせて、見出しの書式に関して留意すべきいくつかの事項を述べます。 1.      見出しの置き方 2.      見出しに使う文字の「書体・大きさ」および見出しの「前後の間隔」 3.      技術文書の規模に応じた見出しの書式 4.      書式の例：章と節で構成される数ページの報告書 5.      書式の例：章、節および項で構成される数十ページの技術解説 6.      書式の例：章、節、項および目で構成される 100 ページ超のマニュアル 7.      見出しおよび段落のインデントの要否 8.      陥りやすい事例：めりはりがない書式 9.      陥りやすい事例：意味に乏しい書式 まとめ 後　記　 © Yamanouchi Takaaki 2024 ［注］今回のテーマは他の回と関わる部分が多いため、以前に解説した内容と重複する箇所があります。 ブログの本文は、下記の PDF ファイルで閲覧できま...

　ここでの「副本文」とは、添書きを示唆するアスタリスク「＊」などの文頭記号を付けて段落から便宜的に改行した補足文です。段落に添えて参照先を示すのも、副本文の使い方の一つです。 　＊　動作モードの移行方法は、 1-5 「動作モードの設定」を参照してください。 　ここでの「注記」とは、「重要」などの注見出しを付けて段落から便宜的に改行した補足文です。 ［重要］　 測定を中断できる場合は、速やかにバッテリの充電およびデータの外部保存を行ってください。 　いずれも、段落の補足文でありつつ読者の目が自然に向く書式を選ぶ必要があります。副本文も注記も、段落より目立っては本末転倒です。 　今回は、技術文書の種別に応じた副本文および注記の書式を解説してゆきます。それぞれを使う際の基本は、別の回で解説します。 1.      副本文と注記の違い 2.      報告書での使い方 3.      マニュアル・製品解説での使い方 4.      機能仕様書での使い方 5.      副本文に付く文頭記号の選び方 6.      注記に付く注見出しの選び方 7.      副本文を伴う注記の表し方 まとめ 後　記　 © Yamanouchi Takaaki 2024 ［注］今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全17ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文を PDF ファイルにして概要・目次に添付しました。 HTML 形式ではワープロ...

　箇条書きの利点の一つは、項目に表された文あるいは名詞句の見やすさです。 　項目ごとに区切られているため、それぞれが見やすい。また、文頭記号あるいは文頭番号が視線を項目に誘導する。 　一方で、文で表された項目に適度な間隔がないと、前後の行が干渉して読みづらくなります。また、文頭記号が小さかったり行に埋もれたりすると、項目の始まりがはっきりしなくなります。 　今回は、箇条書きを表す際の書式の選び方を解説します。また、基本となる書式に対して一部の文書に限って使われる便宜的な書式にも触れてゆきます。 1.      基本となる書式 2.      陥りやすい事例： 　 項目が見づらい箇条書き 3.      「項目の行間」および「項目の間隔」の設定 4.      「文頭記号」の選び方 5.      「文頭番号」の選び方 6.      折り返しになった際の２行目以降の扱い方 7.      マニュアルや製品解説などに限られる便宜的な書式 8.      規定集などに限られる便宜的な書式 まとめ 後　記　 © Yamanouchi Takaaki 2024 ［注］今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全19ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文を PDF ファイルにして概要・目次に添付しました。 HTML 形式ではワープロ文書の表し方を解説しきれないというのがその理由です。 l 　 P...

　「表」にも、見やすくするためのさまざまな工夫を取り入れられます。 例 1 　   外枠に太めの線を使うと、枠組みがはっきりして表に目が向きやすくなる。 例 2 　   各列の題目を「項目の中央」に置くと、左右にできる余白によって題目が強調される。 　 　今回は、表の書式の基本に加えて表を見やすくする工夫を解説します。 1.      基本となる書式 2.      線の使い方 3.      陥りやすい事例：題目行を見づらくしかねない書式 4.      陥りやすい事例：項目を見づらくしかねない書式 5.      表の全幅の決め方 6.      表番号・表説明の付け方 7.      表が抱える課題 8.      工夫：列数に対して行数が多い表の 2 段組み 9.      工夫：複数のページにわたる表の分割 10.  　  工夫：統合による列数の削減 11.  　  工夫：第 1 列の見出し化による列数の削減 12.  　  工夫： 　 が主体の表での「列の行化」 まとめ 後　記　 © Yamanouchi Takaaki 2024 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全20ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文を PDF ファイルにして概要・目次に添付しました。 HTML 形式ではワープロ文書の表し方を解説しき...