SIerの書くドキュメントの品質管理

» 2018/11/12

つい最近、ドキュメントを書いていてふと思いました。いったいこのドキュメントの品質はどのくらいのものを目指して作られているのだろうかと。だいたいどこのプロジェクトでもドキュメントをどう書くかという指針のドキュメントがあると思います。ただ、そのドキュメント自体がExcel方眼紙で読みにくいというのがほとんどです。

品質の基準になるドキュメントの品質が悪いと、まともなドキュメントが書ける気がしません。相応に品質をもとめるのであれば、せめてドキュメントの指針くらいその手のプロに作ってもらったらどうかと思います。お客さんに出す成果物なので綺麗に仕上げたいと思うなら、ちゃんとお金を払ってキチンとしたものを作れるようにしたらいいと思います。

もしこれがへっぽこ大企業ではなく、ちゃんと工夫を惜しまない会社が作ったら、校正はプロに任せてエンジニアは内容に集中するのかもしれません。校正を頼むといっても、あの程度の量のドキュメントなら、ピンポイントで仕事を頼めば用は済むと思います。誤読が許されないものを求めるのであれば、素人が頑張るよりそちらの方が効率も良いし、結果的に安くできるのではないでしょうか。

レビューをしているのが素人なら、レビューの回数は何の品質保証にもなりません。むしろ、プロに校正してもらった方が品質保証の裏付けにはなると思います。内容についても同様です。エンジニアだから技術文書が自在に書けると思うのは無知です。エンジニアライフの編集者さんと記事の書き方について話したことがありますが、文章を書くプロの方とそこら辺のエンジニアでは断然レベルが違います。

プロの編集者さんと話すと、自分たちの書いているドキュメントがいかに歯抜けの多いものか思い知らされます。本当にお客さんのことを考えるなら、エンジニアの下手クソな真心より淡々とこなしたプロの技の方がありがたいです。真心で最高品質を目指している時点で、ドキュメントの品質管理は崩壊しています。そういういい加減な品質管理が、日本のSIerの仕事の質の低さに繋がっているように思います。