ドキュメントを読んでもらうという配慮

ITコーディネータの吉田聖書よしだみふみです。

皆さんは部下や委託先の方々に
ドキュメントを作成してもらうことがあると思います。
その時、受領したドキュメントを
どのような観点でレビューしているでしょうか。

もちろん、ドキュメントといっても
目的や用途はバラバラですから、
それによってレビューの観点も異なるのは当然です。
ですが、どんなドキュメントでも、
それが読んでもらうように作られているか
という観点は共通のものであると思います。

私がかつて会社員時代に、
とあるシステムのサーバーとクライアント間の
通信プロトコルを設計した時の話です。
その通信プロトコルの処理手順を詳細に定義するため、
サーバーとクライアントのやり取りを、
今でいうシーケンス図にまとめました。
それが、
あらゆる状態であらゆるエラーケースを想定したため、
数十ページにも及ぶ大作になってしまいました。

それを当時の上司や先輩にレビューしてもらったのですが、
「やりたいことは分かるが…」
と言い方に配慮しながらも、
「このようにしたら良くなるよ」
というアドバイスをいただきました。

えらい工数をかけて作成したものだったので
多少の落胆はありましたが、
そんな私に対して上司は
「ここをこのようにすれば、
せっかく作ったものも無駄にならないよ」
と付け加えてくださいました。
最終的には状態遷移図を利用することで
すっきりと10ページ程度に収めることが出来、
とても使いやすいドキュメントになったと思います。

レビューする際には大前提として
「そのドキュメントが読む価値があるか」
という観点でチェックし、
「どのように改善したらそのドキュメントが
読むに価するものになるか」を考えて
アドバイスしていただきたいと思います。

また、ドキュメントの品質とは少々異なるのですが、
私がレビューをする立場にいた時の話です。
レビューイが
レビュー対象のドキュメントを印刷してきたのですが、
もともと文字がそれほど大きくないものを
4 in 1(1枚に4ページ分を縮小したレイアウト)で印刷してきたのです。
レビューイも説明しながら
判読しにくい箇所があったようでしたが、
こちらも説明を聞きながら
もう読む気が失せていました。
よっぽど出直してもらうと思いましたが、
そんな気力もそがれてしまいました。

最近ではドキュメントを印刷してレビューする
というケースがあまりないかもしれませんが、
年配の方に対しては拡大印刷して渡すなど、
読んでもらうという配慮は何より大切なことだと思います。



関連記事

プロマネの右腕

クロスイデアでは、新サービス・新ビジネスの 立上げや計画を中心に
プロジェクトマネジメントの支援を行っています。

新サービスの企画を任されたけど どう進めていいか悩んでいる担当者、
部下に新しい企画を任せたけど このままで大丈夫か不安な管理職の方、
以下のサイトをご参照ください。
https://www.crossidea.co.jp/services/right-hand-pmo.html

YouTubeにて動画配信中!

プロジェクトマネジメントのノウハウを
YouTubeで配信しています。
ブログと併せてご活用ください。

Comments are closed.