2010年12月05日(日)

質問の答えを書く

テーマ:ブログ

ビジネスによくあるシーン。


 1. ドキュメントを作る
 2. 誰かに見せる
 3. 質問される
 4. 質問に答える
 5. 納得してもらう


例えば、報告書の類とか、我々の仕事なら設計書のレビューなどもそうだ。また、ソースコードのレビューも同じである(以下、「ドキュメント」にはソースコードも含むものとする)。


さて、上記の流れの後でそのまま終わってしまう人も多いのだが、それはよくない。


単純に考えると、質問された内容というのは、「作成したドキュメントから読み取れなかったこと」である。しかも、少なくとも聞き手が質問せずにはおられない程度に「重要なこと」なのである。


そのため、今後、別の人(たとえば上司のそのまた上司)がこのドキュメントを読んだら、同じ質問をしてくる可能性が高い。質問の機会がなければ誤解されてしまうかもしれない。また、説明を受けた人ですら、後になってその内容が思い出せなくなって、違う解釈をしてしまうかもしれない。


「質問をする人に知識や読解力がないせいだ」と言いたい時もあるだろう。しかし、読ませる相手のレベルに合っていないドキュメントは悪いドキュメントである。幼児向けの絵本を漢字ばかりで書いているようなものだ。



ドキュメントの説明で質問があったなら、口頭で説明しておしまいにせず、説明した内容をドキュメントから読み取れるように、追記や修正をしておきたい。


ソースコードの場合なら、構造を見直す(リファクタリング)、変数名やクラス名・関数名を見直す、コメントを見直す、といった対応を検討すべきだろう。


特に、品質管理のために行うレビューの場合は、レビューアにドキュメントの内容を伝えることが目的ではなく、ドキュメントを良くすることが目的なのだから、なおさらである。





■関連記事
この文書は誰が読むのか
どこまで書くか設計書
書かずに伝える
ドキュメントへの「朱筆」について考える




ついてきなぁ!『設計書ワザ』で勝負する技術者となれ!
國井 良昌
日刊工業新聞社
売り上げランキング: 83877

リファクタリング―プログラムの体質改善テクニック (Object Technology Series)
マーチン ファウラー Martin Fowler 児玉 公信 平澤 章 友野 晶夫 梅沢 真史
ピアソンエデュケーション
売り上げランキング: 5343
AD
いいね!した人  |  コメント(13)  |  リブログ(0)

argvさんの読者になろう

ブログの更新情報が受け取れて、アクセスが簡単になります

コメント

[コメントをする]

13 ■(^-^*)/コンチャ!

コメント書き込ませて頂きました!
人柄が出るブログですね…
次の更新のときにまた来ますよ~

12 ■U。・x・)ノ チワン!

照れくさいですがコメント残させて頂きました!
好感が持てる記事です!
勉強になりました。またきます!

11 ■、こんにちは!

物凄くあなたのに興味がわきました♪
ブログってその人の個性も出ますし楽しいですよね!?
良ければ色々お話し出来たら嬉しいです♪

10 ■♪よろしくお願いします。

ステキなブログだと思います!なんていうか共感わきました。よろしければこちらのブログも読んで頂ければ嬉しいです。
これからもよろしくお願いします。
私はタンタンとしたブログ書いてますけど、よかったら来てくださいね!

9 ■お初です!コメント残しちゃってご免なさい

σ(≧ω≦*)初めまして…ってえっと、実はargvさんのブログファンの者です((ヾ(*ゝω・*)ノ☆゚+.⊇ωレニちゎ゚+.☆実は…最近色々と悩みごとがあったんですけど、でもargvさんのブログを見て、自分自身頑張らなきゃいけないって思ったり、凄くためになった部分もあったのです。ここで「ありがとう」って言いたいんですけど、やっぱりこんな素敵なブログを書き込む人は、凄い素敵な人なんだろうって興味を持っちゃったんです( ´∀`)だから、出来れば引越してきたばかりで寂しい私とお友達にってかなり唐突なお願いを含めた上で、私の連絡を載せておきました((●≧艸≦)お暇があったらでいいし、面倒であればこのコメントも反映させないで削除しちゃってOKですからね(;≧∇≦)じゃあ一応期待して待ってます(〃´∀`)

8 ■プログラマさんですか?

将来的に仕事にしたくてアンドロイドアプリを制作しているものです。アプリを作ったのですが、率直な感想を教えていただけないでしょうか?『オニポコ』と『ちゃびりぼんうらない』というアプリです。どうぞよろしくお願いします。

7 ■お邪魔いたします。

ブログ、すごく読みやすかったです
文章の書き方がとても上手なんですね~
ブログ、見にまた寄りますね☆彡

6 ■こんにちは!

ブログ眺めてました(笑)
等身大のステキなブログですね♪
私のブログも読んでみてください(^▽^)/

5 ■逆ですよ

質問が出るというのはある程度理解されたからです。
理解された上で読み手が想定している部分が文章の中に存在しなかったからです。
なので、適切な質問(××はどうなっている?のような)が出るというのは正しい事をしている印なのです。

本当に理解されなかったら質問も出ませんからね。

4 ■はじめまして

ソフトウェアの品質保証に関するブログ書いています。
でも、指摘してもらった方とのコミュニケーションも大事だと思います。
興味深いブログです。今後とも、よろしくお願いします。

3 ■相手に伝えるためには大切ですよね。

こんばんは。

大変興味深い記事でした。

広告などのコピーはお客さんに疑問が生じると
わざわざ質問してこないケースの方が多いので、
分かりやすさは売上に直結するものです。

報告書などに関しても読み手がどう受け止めるか、
またその受け止め方をフィードバックして次に活かす事がとても大切ですね。

ありがとうございました。

2 ■ごもっとも。。。

ごもっともな事です。
直近の会社では、資料を作る事自体が無駄。作業効率Upのもと、口頭説明が中心となりました。
たまに資料を作っても、明らかに突っ込まれる点について、記載がされておらず質疑応答で突っ込まれ、資料が手元にないために会議時間が伸びます。
まぁ、そんな状態を見てみぬふりをする上がいるので仕方ないのですが、、、

1 ■目から鱗です。

大変参考になりました。私もドキュメントを見ても分からず、担当者へ問い合わせることがちょくちょくあります。
自分がドキュメントを作るときは、読み手が分かる文書作成に取り組んでいこうと思います。

コメント投稿

AD

ブログをはじめる

たくさんの芸能人・有名人が
書いているAmebaブログを
無料で簡単にはじめることができます。

公式トップブロガーへ応募

多くの方にご紹介したいブログを
執筆する方を「公式トップブロガー」
として認定しております。

芸能人・有名人ブログを開設

Amebaブログでは、芸能人・有名人ブログを
ご希望される著名人の方/事務所様を
随時募集しております。