開発言語と、通販対応配送センターERPの開発者の視点を中心としたコラムです。

「戦略的ドキュメント」でユルくても、スマートに結果を出せるやり方

»

 「ドキュメントを書く」ということは、非常に基本的な事です。そして、システム開発のお仕事をしたことがある人ならば、誰しもが、経験があることだと思います。

 しかし、このドキュメントを書くという仕事は、あたり前すぎて非常に地味な仕事であり、コミュニケーションの必要よりも、「動くものを作る」ことの優先順位が圧倒的に高い時には、いとも簡単に無視されてしまいます。

■ドキュメントを書かないとどうなるの?

 特に、新人時代の若かりし日々の私も含め(最近はかなりしっかりしてます!)、ユルい系の人は、簡単にドキュメントを書かない方向に出てしまいます。

 そうしたときには、最初はよいのですが、後の方になって、「あれ、ここどうなってたっけ?」という問題に遭遇します。また、開発からテストへなどのフェイズの移行後にそういう事態は頻発し、自分が書いたコードと脳内コンピュータをフル活用して、必死に思い出せるときは思い出します(ワイルドだろぉ~~)。

 思い出せないことがたまってくると、テスト設計時に自分で考えた仕様が思い出せないなど、かなり大変で、この「思い出せない」がある程度たまっていくとデスマーチになっていきます。

■ドキュメントを書くことに対する「評価」が大事

 ドキュメントが、いとも簡単に必要な部分まで省略されてしまうのは、ドキュメントを書くということに対しての「評価」が、開発の現場では雑で、そして低いからだと思います。

 また、ドキュメントを書いても「誰も読まないのではないか」と思うこともあると思います。

 筆者もそう考えて来たのですが、自分の理想である、「どこでも自由に自分の時間を使って開発する」というスタイルを追求するようになってから、このドキュメントの大事さに気付くことができました。

 普段、コミュニケーションをとる人が近くにいれば、「すぐ聞けるからいいや」と思ってしまいがちですが、実は、この多くの部分は、きちんとドキュメントに簡潔に分かりやすく書いておけば必要のないことである場合が多いです。

 プログラムは、開発して動けば評価がされるし、営業は契約をとってくれば評価されます。これらが評価されやすいのは、評価する目的と方向性がきちんと定まっているからです。

 ドキュメントも同様に、何を目的とするのかを考え、戦略的に作っていけばよいのです。

■ユルく生きながら結果を出すために、腹をくくろう!

 「たくさんドキュメントを書いた方が、上司に、すごい仕事をやってそうに見られる!!」

 確かに、一理どころでなく、二理も三理もあるかもしれません。しかし、たくさんドキュメントを作るのは、決してユルくありません。

 それを行うには、

  • 効率的にコピペを行う技術
  • テンプレート形式で誰も読まないデータをたくさん貼り付ける自動コンテンツ生成技術(上級者はexcelマクロを使う)
  • コピペや自動生成したものを、いかにも手作りしたように表現する表現力

が必要です。

 これは、実はかなり高度な技術で、新卒や新人の皆さんには真似ができない上に、これだけでは実は結果を出すことが不可能で、「とにかく作業場もしくは会社に長く居続ける」というスキルとセットでなければ効果を発揮しません。

 さらに、成果物がこれではでき上がってこないので、想像を絶する時間を作業現場で過ごす覚悟が必要で、これを継続的に行わなければ周りからは評価されません。

 なので、ユルい人たちは絶対に無理です。

 ここは、建設的に「早くスマートに仕事を終わらせて、早く家に帰ろう」の精神でいくべきだと思います。

■それぞれのドキュメントは短く、そして目的を持って

 ドキュメントを作るときのコツは、筆者の経験では、

  • ドキュメントごとに1つの目的を決めて、目的ごとにドキュメントを書く
  • ドキュメントには、決められた目的以外のことはなるべく書かない
  • なるべく、少ない量でドキュメントを済ませられるように工夫する

が有効なドキュメントの書き方だと思っています。

 これらの工夫をすることによって、目的志向の戦略的ドキュメントが用意され、読むものを選ぶときに、どれを読んでよいかすぐに分かりますし、読んでいて、余計な情報が入ってこないので、知りたいことをすぐに知ることができます。

■そういう筆者は実際にやってますか?

 それは、ズバリ、やっています。

 今は、ちょうど、自分が開発したOpen-Ecommerceという配送センターERPのソフトウェアがあるのですが、この事業の拡大にむけて、ほんの少しですが、組織を拡大中です。

 そうした中で、新しい人に仕事をお願いするためにここで書いたようなドキュメント作成を実践しています。

 昔、参加したプロジェクトよりもはるかにドキュメントは少ない量で済んでいますが、分かりやすいといってもらえているので、今のところは大丈夫なようです(ただ、若干資料が足りないといわれるところに関しては、足りない理由を明らかにしてそれを目的に新しい資料を作っています)。

 今後は、そのようなフローで資料を作るのに必要な機能で、開発サイドのものに関しては、Alinous-Coreの開発環境上でもリアルに行えるように、機能追加をしていく予定です。

Comment(0)

コメント

コメントを投稿する