技術文書の書き方

　ここでの「視覚化」とは、「形がないもの」あるいは「形になっていないもの」の特徴を形にして表すことです。 段落に図を添えるだけが「視覚的な表し方」ではありません。段落を積極的に視覚化するのも有効です。 段落の視覚化　　　箇条書きや表などの「書式」を使って語と文で構成される関係を 見てわかるようにする こと 　視覚化の対象になるのは、段落の要点を補完する「補足文」です。   　文の連なりだけで表すのが、段落ではありせん。工夫をすると、文の主従関係や順序関係のみならず文に内在する条件と結果の関係なども視覚化できます。段落の視覚化は、図・表の有効な使い方にもつながります。 　今回は、箇条書きをはじめとして「文と文」あるいは「語と語」の関係を見てわかるようにする手法を解説します。あわせて、「要点」を文で表すことの重要性を述べます。 1.      「段落の視覚化」の対象 2.      段落に内在する主従関係の視覚化－副本文および注記－ 3.      補足文の並列関係・順序関係の視覚化－箇条書き－ 4.      語あるいは文の関係の行列化－表－ 5.      「順序と並列が混在した箇条書き」の視覚化－図解－ 6.      段落を視覚化する際のポイント まとめ 後　記　 © Yamanouchi Takaaki 2024 ［注］今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全17ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文を PDF ファイルにして概要・目次に添付しました。 HTML 形式ではワープロ文書の表し方を解説しきれないというのがその理由です。 l 　 PDF ファイ...

　ここでの「副本文」とは、添書きを示唆するアスタリスク「＊」などの文頭記号を付けて段落から便宜的に改行した補足文です。段落に添えて参照先を示すのも、副本文の使い方の一つです。 ＊ 　 動作モードの移行方法は、「 1-5 　動作モードの設定」を参照してください。　                                                                                                              　　･･･　段落に参照先を添える副本文の例 　関連事項の参照先や欧文のつづり方などだけでなく、段落の要点からややそれた添書き的な事項を副本文にすると、他の文との主従関係が明確になります。また、段落の一部を副本文にすると、段落を見かけ短くできます。 　今回は、副本文の有効な使い方を述べるとともに、括弧書きや脚注な...

　ここでの「注記」とは、「重要」などの注見出しを付けて段落から便宜的に改行した補足文です。 　 ［重要］ 　　 測定を中断できる場合は、速やかにバッテリの充電およびデータの外部保存を行ってください。 注記の前に置く「重要」などの語を「注見出し」と呼びます。注見出しによって注記の趣旨が明確になります。 技術文書での注記は、主に付帯的な重要事項を段落に添える際に用いられます。 　今回は、注記の有効な使い方を解説するとともに、同じく段落に補足を添える書式である副本文との使い分けを述べてゆきます。副本文の使い方は、別の回で解説します。 1.      段落からの「注記」の抽出 2.      注記を表す際の原則 3.      「注見出し」と見出し構成「章・節・項・目」との違い 4.      「注見出し」に使う語の選び方 5.      「安全に関する注意」と「一般的な注意」の使い分け 6.      注記の表し方 7.      副本文と注記の違い 8.      副本文と注記を使い分ける利点 9.      陥りやすい事例：参照番号形式の注記 10.  　  陥りやすい事例：見出しの 1 項目に相当する注記 11.  　  陥りやすい事例：注記のまとめ置き まとめ 後　記 © Yamanouchi Takaaki 2024 ブログの本文は、下記の PDF ファイルで閲覧できます。 本文の PDF ファイル （ A4 判・全18ページ） 【重要】　 PDF ファイルの表示に伴うトラブルへの責任は、一切負いません。 　ブログではタイトルを開いたページに本文を表すのが普...

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