いろいろな仕事を渡り歩き、今はインフラ系エンジニアをやっている。いろんな業種からの視点も交えてコラムを綴らせていただきます。

SESでドキュメントのレビューを頼まれたら

»

SESのドキュメントレビューは品質を上げない

SESで働いているが、最近、業務でドキュメントのレビューを頼まれることがよくある。実際にやってみると分かるが、本当にニホンザルレベルの適当さだ。よくあんな適当な仕事でお金を貰えるなぁと逆に関心する。・・・とレベルの低さを叩くだけでも軽く一本コラムを書けそうだ。

ただ、愚痴を書き殴ったコラムを書いても、スッとするかもしれないが何の問題解決にもならない。また、怒濤のごとく押し寄せる業務を頑張りだけで乗り越えたところで、何の利益もない。転職の際にそれをアピールしたら、キーキ騒ぐだけのニホンザルから、パワフルなゴリラにクラスチェンジするくらいなものだ。つまり、猿という評価は変わらない。

類人猿から人へ進化するには、論理的な裏付けができる方法で問題を解決できるようになる必要がある。今回のコラムで書くのは、SESでレビューを頼まれた時の対応策だ。ニホンザルの群れの中でもちゃんと人間レベルの仕事をするための具体的なやり方だ。ただ、最初に釘を刺しておくが、この方法をやったからといってドキュメントの品質は上がらない。

むしろ、力まかせのレビューは品質を壊す。ここで言う品質とは、かかった時間とお金と労力に対しての成果物の質だ。何回もレビューを通ったから品質が高いというのは間違いだ。また、現場で使われているから信頼性が高いというのも間違いだ。実際のところ、作ったドキュメントが本当に意義のあるものだったかは、お金をかけて公平な第三者に調査してもらわないと分からないところだろう。

レビューする前から既に負けている

そもそもを言えば、ドキュメントの作り方がデタラメだ。当然、レビューのやり方もデタラメになる。仕様が固まっていなかったり、元になるデータシートを作らずにドキュメントを書き始める。本来なら、何が正しいか基準が定まらないのにドキュメントは書けるはずが無い。それでも進捗を確保するためにネタが無いままでドキュメントを書いてしまう。取材をせずに予想だけで書いた新聞記事と同じだ。

デタラメなドキュメントに対してキチンとしたレビューはできない。それは割り切っていこう。本来の流れで考えるなら、内容を検証が完了してから校正をする。その後にレイアウトを整えて納品という流れだ。SESでやっているレビューはこれを全部一つの行程でやろうとする。かなり無茶なやり方だ。しかも、ドキュメントをわざわざ突き返して修正させてから再レビューする。時間の無駄としか言いようが無い。レビューした人がサッと直してそのまま行程を進めろと指摘したい。

なぜこうなるのか、原因は計画の立て方にある。SESでは通常、「ドキュメントの作成」の次に「ドキュメントのレビュー」とスケジュールが書かれている。まず、このスケジュールの立て方が不適切だ。ドキュメントを細かく区切って、調査、記述、確認と作業をブレイクダウンできなくなる。こういう計画至上主義で動いていると、本来やるべきプロセスと計画との間にひずみが発生しても調整できなくなる。

最大の問題点は、間違えていたら怒るということだ。これだけデタラメなやり方でドキュメントを書いているのだ。普通は間違える。また、怒ることで作業者が萎縮して、悪いスパイラルにしかならない。レビューする人が感情を爆発させるのは、スケジュール至上主義の締め付けと疲れだ。これだけリソースを無尽蔵に消費するやり方でドキュメントを書いているのだ。残業が多発して疲弊するのは当然だ。

実際のレビュー

SESでおこなうドキュメントのレビューだが、まとめるとこういう問題点がある。

  • ドキュメントの検証するデータが無い
  • 内容の確認、校正、レイアウトの区別がついていない
  • 作業の細分化ができない
  • リソースを無尽蔵に消費する

これら一つ一つに対してアプローチしていくことは可能だ。一つ一つ、順を追って説明していく。

まず、ドキュメントを検証するデータが無いことだが、これは以外と簡単に対応できる。レビューする前にドキュメントを書いた人に、何をみてドキュメントを書いたのかをヒアリングすればいいのだ。情報のソースが分かれば事前に指摘できるし、見ているソースが違っていたという間違いが防げる。

あと、レビューをする前にレビューの基準について書かれたドキュメントを整理しておこう。内容確認に関する項目、校正に関しての項目、レイアウトに関する項目にカテゴライズして別表にまとめておこう。レビューするときは、それぞれのカテゴリ毎に作業をしていけばいい。レイアウトや校正に関する項目であれば、別に技術が無い人がやっても大して結果は変わらない。いざ工数が推しているなら、空いている人にそこを任せてもいい。

作業の細分化に関しては、ドキュメントを区切って見ていけばいい。レビューしている人をみると、意外と頭から最後まで一気に読み通している人を多く見かける。段階的に区分けしていかないと、どこからどこまでかOKか区別がつかなくなる。また、区切ってレビューをしていけば、人に作業を引き継ぐことが可能になる。また、区切ることで間違いの傾向が分かりやすくなる。指摘から修正のプロセスを効率化することができる。

方法を講じていくことで人的なリソースの無駄を省くことができる。ただ、突き詰めていくとレビューする人の人格や能力になってくる。怒りやすい人、完璧主義の人、ミスを恐れる心の弱い人は無駄な行動が増えやすい。結果、人的リソースを無尽蔵に消費してチーム全体が疲弊する。やり方や心意気だけでは効率よく仕事はできない。これが一番大きなポイントだ。

最後に何をもってくるかで結論は変わる

私はドキュメントのレビューをするまでは、こんな面倒くさいことは絶対やりたくないと思っていた。しかし、実際やってみると、思っていたより整理できる要素がたくさんあることに気付いた。SESでのドキュメント作成は、根底からやり方がおかしいケースがほとんどだが、ちょっとした情報の整理で仕事の速度を上げて残業を減らすくらいのことはできることに気付いた。

まともなドキュメントを書くという観点からは、SESでやっている手法は全否定する。そもそも、作成するドキュメントの選定基準からおかしい。間違えた基準で正しいと言われることは、まともなドキュメントを作ろうとしているところから見れば間違えた基準が根付いていることになる。変なやり方が癖になると転職で泣きを見ることになる。

スケジュールをこなしたいだけの人には、そういう人の正しさがある。まっとうなドキュメントを書きたい人には、そういう人の正しさがある。どっちを取るかは自由だ。ただし、結果がどうなるかは、選んだ手段で決まる。ただ、スキルが足りない人は選べる手段が減るのと、低い質の手段しか選べなくなる。自分の選んだ手段と結果が一致するとも限らない。

SESに限らず、納品物に「ドキュメント」と書いてあると、大多数の人が下書きや下調べ無しでいきなり書き始める。レビュー以前に必要な情報が抜ける。逆に言えば、ちょっとでも下書や下調べをするだけで大きなアドバンテージになる。ドキュメントの質を決めるのはあくまで集めた情報とまとめ方に依存する。それが抜けた状態でレビューをしたり議論をしても、はっきり言って時間の無駄だ。そういう環境にいるなら、サッサと転職を狙った方がいいと思う。

Comment(0)

コメント

コメントを投稿する