ドキュメントはコミュニケーション

あなたも文書・ドキュメントを書く場合に、誰に読ませるのか、読ませる目的は何かを意識して書いていらっしゃいますよね？

続きを読むか、応援をひとつ。

文書を誰に読ませるか、何のために読ませるかというのは基本だと思います。

そのためにはわかりやすいのは、構成を統一することです。
つまり文書の骨組みを統一すると言うことです。

何をはじめに書いて、次に何を書いて、最後はどう締めるのか。こういう何がどこにどういう順番で書いてあるのかがわかれば、どこに知りたい情報があるのかが、おのずとわかるようになりますよね。

これがいろいろ変わると読み手も混乱してしまうことが容易にお分かりになると思います。

仕事でこれを実現するためには、共通するルールを決めるのが手っ取り早いことになります。つまり、文書の仕様を決めるということです。

○○の文書は最低限こういう形で、こういう順番で付け加えるならば、わかりやすい注釈を入れるなど、かっちりと枠組みを決めておくのが共通した意識をつくることにつながり、読み手書き手の認識をつなげることになりますね。

よくソフトウェアの開発で、たまに自分達で仕様書などのドキュメントを作らないという人がいますが、はっきり言って２流以下の仕事であると私は思います。

なぜそういうかといえば、仕様書は自分達の仕事の証であり、その内容をある意味証明するものだと思うからです。

極端に言えば、ソフトウェアは時々刻々変化していくものです。それが為に、元々はどういう意図で何を目的にソフトをつくるのかを明確にしていけば、それを継承する場合でも、逆に見直す場合にも、それが大きな意味をもつと思うからです。

そう、このシリーズのはじめに戻りますが、作成するドキュメントがコミュニケーションにつながると思うからです。

コミュニケーションですから、仕事に於いてコミュニケーションを否定する行為というのは、まともな仕事相手としてふさわしくないというのが私の考えです。

ドキュメントはコミュニケーションですから、それをしっかり残す、残す努力をすることが大事なことです。次回はその中身の書き方について考えてみたいと思います。

最後にランキングにもご協力をお願いします。