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


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

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

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

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

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

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

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

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



ここでお知らせです。

25~35歳くらいの現場リーダーを対象に、
「理解されやすい業務フロー」を作るワークショップを開催します。
業務フローは業務の見える化には欠かせない基礎的な図式で、
これが書ける・読めるようになると
現場の業務改善・業務改革に役立ちます。

是非若いうちに身に着けておきませんか。

詳細・お申込みはこちらのopnlab社のサイトにて。


Comments are closed.