この記事の目的
テクニカルライティング技術に関する「フォーマット」と「ルール」について理解する
目次
▼表現設計
表現設計とは、文字の大きさやフォント、図や表をどのように配置するかなどを決めること。表現設計を決めることで、表現に統一感が出せる。また、文章作成の分業化も可能になる。
種類
表現設計には、下記のとおり様々なことを決めることができる。
- デザイン表現：何を文章で、何を図形で表現するかといった、レイアウトを作成すること
- 基本フォーマット：デザイン表現に基づき、最終的な見せ方を決めたもの
- 執筆ルールの作成：文字・用字・用語・表記を統一するためのルール
▼基本フォーマット
基本フォーマットとは、視覚的な設計図である。
役割
- 読み手の視点をスムーズに誘導する
- 全体構成が明確にわかる
- 必要な情報へすぐにたどり着ける
- 統一感をもたせる
構成要素
一般的な構成要素は、以下の通りである。
- 見出し
- 本文
- 操作手順
- 関連情報
- 図表
- 検索情報
- 余白
▼執筆ルール
一貫性を保つためにルールを決めることが望ましい。
種類
- 見出しの付け方
- ですます調なのかである調なのか
- 記号の種類や使い方
- 箇条書きのルール
- 数値の半角・全角の使い分け
など
例）
見出しの付け方：見出しは、行頭に「## ▼ 見出し」をつける。小見出しを付ける場合は、「## 小見出し」を使用する。