はじめに
自分で決めたルールをあまりにも忘れてしまうので、書き留めておこうと思いました。
自分ルールを忘れてこれに立ち返ったとき、「うわめんどくせ…」とならないようできるだけシンプルなドキュメントを作成できるようにすることを目的としています。
想定する読者
未来の自分です。
もしくはドキュメント作成の際に自分の中に軸がなくて自信が持てない方に届けばうれしいです。
基本方針
- 図や文字の斜体、太字などは使いすぎず、極力箇条書きでまとめる努力をする
- メンテナンス性の観点から。図とか毎回差し替えるの大変だよね
- できるだけフォーマットを作成して汎用性を持たせる
- フォーマットを作れば一部だけフォントが違ったり色が違ったり、ミスや資料作成時のばらつきを可能な限りなくせるはず
- いいフォーマットやドキュメント作成時参考になる資料があればどんどん自分の中に取り込もう
- 参考資料等にフォーマット、ドキュメント書き方指針等の出典もとを記載する
- 紙面に出力しても見づらくないかを確認する
- わかりやすい資料は大体A4に出力しても簡潔にわかりやすくまとまっているため
- Excelなどで大きな表なってしまった場合は、印刷レイアウトに特に注意が必要
- わかりやすさ第一として、あまりにも大きな表なってしまう場合は表の分割も検討する
- Wordであればページ区切りを適宜使用する
- 地球に厳しくしないように、両面印刷して確認する
- 「外部に納品できる」レベルを目指す
- 自分ルールだし目指す必要もないけど、品質を向上させたいので…
- つまらんことだけどこういうところで風下に立ちたくないので…
- 自分ルールではあるので、表紙は基本作らない
- メンテナンス性の観点から
- ドキュメントの作成目的はコミュニケーションであることを忘れない
- コミュニケーションには必ず伝えたい相手がいるはず
- 相手が見やすいか、見ていて労力がかからないかを考える
- 言葉の言い回しなどは相手と互いに前提が共有できているか考える
- 専門用語や複雑な図、手順などには凡例をつけるのもアリかも
- 相手と言葉を大切に
あいまいな言葉はできるだけ辞書を引く、意味を調べること
フォント
資料作成時に使用するフォントは、Meiryo UIとする。
ヘッダー・フッター
ヘッダーは使用しない。フッターはページ番号のみとする。（ページ番号は真ん中）
→右開き、左開きどちらでもページが見やすいように
色
統一性を持たせて、できるだけ少ない色での表現を心がける。
青
オレンジ
ピンク
黄色
黄緑？
グレーっぽい青
画像
Word、Excelに画像を貼付する場合は、画像に黒線を設定する
フローチャートなど図形を複数使いたい場合は原則SmartArtを利用する
図形
図形の枠は2.5ptとする
各ツールの利用基準
Word
- 方針や自分ルール、手順など一度作成したら頻繁には更新しないものを作成するとき
- 外部に提出する目的で体裁・書式について配慮が必要であるとき
Excel
- 表をメインに説明したいとき
- データを一覧にしたいとき
PowerPoint
- 図や画像をメインに説明したいとき
- できるだけ紙面出力時はノート形式で出力する(ノート部分に補足情報など書けるのが非常によい)
Markdown
- アイデアや設計書など、バーっと書きたいとき
- リリースノートなど、箇条書きでちょこちょこ書いて画像や図は多用しないとき
- 自分で作ったアプリとかでもファイル、内容を使いたいとき
- システムに食わせるのは基本テキストまたはCSVとする
- 文字コードは基本Shift-JISとする
各ツール利用方法TIPS
既存の書式を自分ルール書式で上書きする方法
画像はWordだが、Excel、PowerPointでも同様に「書式のコピー/貼り付け」が可能
ファイル新規作成時に、デフォルトのフォントを変更する方法
参考文献
変更履歴
2025年1月21日_新規作成