1-8 「ページ数が多い技術文書」の見出し構成
大規模な技術文書では、ページ数に伴って見出しの数が多くなります。だからといって、100ページ超のマニュアルで不要に見出しを細分すると、読者には知りたい事項が見つけづらくなるという不便が生じます。
ページ数が多い技術文書 ・・・ 見出しの数が多くなるため、下位の階層まで見出しが細分されやすい。
ページ数が多い技術文書こそ必要な項目が見つけやすくかつ負担なく読める見出し構成でなくてはなりません。それには、「読者が知りたい事項」あるいは「知るべき事項」を単元化して上位の見出しに置く必要があります。
ポイント 「解説の基本単位」を第2階層である「節」に置く。 *「解説の基本単位」は後述
ページ数が多い技術文書は、分担執筆が想定されます。合理性を欠いた見出し構成で執筆を始めると、後になって特定の項目にページ数が偏るなどの無理が生じやすくなります。
ポイント 章と節のページ数の見積もりをしてから執筆を始める。
なお、ここでの1ページはA4判縦使い・1段組みを想定します。
今回は、ページ数が多い技術文書を表す際に見出しの各階層で何を表すべきかにポイントを置いて解説します。あわせて、見出し番号や図・表番号などの書式にも触れてゆきます。
1. 「解説の基本単位」の置き方
2. 見出しの階層数
3. 「章」の扱い方
4. 「節」の扱い方
5. 「項」と「目」の扱い方
6. 見出しの細分を避ける工夫
7. 適した章見出し・節見出しの数
8. 適した見出し番号書式
9. ページ番号および図・表番号の付け方
10. 表紙、序文および目次の扱い方
11. 編構成の扱い方
12. 執筆の進め方
まとめ
後 記
© Yamanouchi Takaaki 2024
[注]今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。
ブログの本文は、下記のPDFファイルで閲覧できます。
本文のPDFファイル(A4判・全18ページ)
【重要】 PDFファイルの表示に伴うトラブルへの責任は、一切負いません。
ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文をPDFファイルにして概要・目次に添付しました。HTML形式ではワープロ文書の表し方を解説しきれないというのがその理由です。
l PDFファイルは、5MB以内です。使用する閲覧ソフトウェアによって表示の細部が若干異なる場合があります。
l PDFファイルの利用は、閲覧のみです。共有やダウンロードなどのご要望には応じかねます。
コメント
コメントを投稿