備忘録
設計書
文章

文章を書くための覚書。

まずは以下3つを意識する。

  • 目的…何のために?
  • 対象…誰のために?
  • 必須要素…何を伝えたい?

例)要件定義書
- 目的…システム開発の妥当性を判断する。システム化の前に業務を分析・整理する。
- 対象…ベンダー、システム部門、業務部門
- 必須要素…現状を把握するためのAs-Is、今後どうしていくか検討するためのTo-Be など…

対象が複数いる場合が多いですが、ステークホルダー・中心人物を意識すると良いと思います。

情報収集

  • 情報を収集する。
  • 収集した情報の取捨選択をする。
  • 取捨選択した情報のグルーピングをする。
  • グルーピングした情報を文章にするべく組み立てる。

「誰のため?」「何のため?」を常に意識し、情報を収集すること。

情報の表現

  • 5W1Hを意識して、伝えるべき情報が盛り込まれているか確認。
  • 読み手の前提知識を意識し、正しく情報が伝わるように配慮。
  • 図は導線や余白に注意。色に意味を持たせることも重要。
  • 表は分類する項目を縦軸と横軸のどちらにするか見極める
  • グラフで提示した数値から何を伝えたいかは文章でまとめる

「誰のため?」ということを意識し、同じ内容でも文章の表現を変える。
相手が専門家であれば、専門用語を使った方がわかりやすいだろうし、エンドユーザなら噛み砕いた表現の方がわかりやすいでしょう。

レビュー

  • 対象者の立場になって読み直す
  • 文章を確認する。
  • 体裁を確認する。

ドキュメントの質の向上は作業の信憑性・信頼性の向上につながります。
レビュー時にはチェックリストを利用し、モレなく効率的に実施することも大切です。
また、指摘するときには必ず「どうしてダメなのか」という理由も伝えましょう。