SEに最も必要なスキルは「伝える力」だと言われています。分業が前提となるシステム開発において、意志の伝達がうまく出来ないことは致命的だからです。
よって、作成するドキュメントにも正しく伝える技術が求められるのですが、しかし多くのSEはドキュメント作成を苦手としているようです。
そこで今日は、SEがドキュメント作成で失敗しがちなポイントと、ドキュメント力を強化するための5つの視点について、『エンジニアのための文章術再入門講座』からご紹介します。
1.SEがドキュメント作成で失敗しがちなポイント
SEがドキュメント作成に失敗しがちなポイントは、主に以下の2つです。
- 相手の関心と不一致
- 知識差のための説明が不足
例えば、システム開発プロジェクトの部長向けの進捗報告の場面を思い浮かべてください。性格にもよりますが、一般に部長クラスの方が気にするのは「予算を超過しないか」「顧客との関係は良好か」「今回の開発でチームメンバーにノウハウが蓄積されるようになっているか」といったような大きな視点です。
しかし、この時に「部長レベルで気になるポイント」にフォーカスせずにドキュメントを作成してしまうと、例えば細部の設計の話や個別バグの報告などを延々としてしまいがちで、「これではよく分からない」となってしまいます。
また営業部門長など、技術に明るくない人向けのドキュメントに、「ウォークスルー」とか、「インスペクション」とか書いても分かりません。こういう専門用語を多く使ってしまったり、本来説明が必要な部分を自分本位に省略して書いてしまうと、分かりにくいドキュメントになってしまいます。
2.ドキュメント力を強化するための5つの視点
上記のような問題に陥らないためには、相手の視点に合わせて文章を書けるようになることです。それにはもちろん技術も必要ですが、ここではその前にどのような視点を持っておくべきかについておさらいします。
ビジネスでは、経営者レベルの視点から担当者レベルの視点までさまざまです。経営者は「収益、顧客獲得」のようなビジネスの視点を持ち、ミドルマネジメントはコスト効果やヒューマンリソース、作業スケジュールといった管理上の視点を持ちます。
また、経営層や管理職が全体を鳥瞰する視点を持つのに対し、担当者の視点は部分の個別事項に関するものが多く、これはポジション(経営者から担当者まで)によって関心のある視点は異なるということを意味しています。
つまり、良いドキュメントを作成するためには、説明する人に合わせて多面的な視点で考える必要があります。自分の興味や関心、理解できている視点だけで勝負していては、うまくいきません。
具体的には、以下の5つの視点について、「経営者なら何処に関心をもつか?」「担当者ならどうか?」と、考えてみるといいでしょう。
1.目的の視点
→なぜそれをするのか、しないとどうなるのか
2.リソースの視点
→いつやるのか、誰がやるのか、その理由はなにか
3.進め方の視点
→具体的にどんなステップで行なうのか、その合理性はどうか
4.効果の視点
→効果はどうか、具体性はどうか
5.今後の視点
→将来的にどうなるのか、次は何につながるのか
エンジニアのための文章術再入門講座 | |
芦屋 広太
翔泳社 2009-02-20 |