WEB企業のドキュメント文化

スポンサードリンク

ぼくは新卒から今までWEB企業をいくつか渡り歩いてきたわけなんですが、どこの会社もそれぞれ独自のカルチャーを持っていて、仕事のやり方に関しても当然いろいろ違います。そこで、よく問題になっているというか、企業のカルチャーを反映しやすい面として、ドキュメント文化があります。

WEB企業なんで、どの会社もいいサービスを開発して、たくさんの人が快適に使えるように運用していくわけなんですが、サービスを開発するために、どんな手順を踏むかというのがドキュメント文化になってきます。

ドキュメントがっつり作成派

これはぼくが新卒で入った会社がそうだったんですが、今は社内体制が変わってるらしいので、もう違うかもしれないし、部署やサービスによってもだいぶ違うと思います。ドキュメントがっつり派の場合は、開発するにしても、

・企画書
ちょっとした改修でも、なぜこの改修をしなければいけないのか、どのような方針で改修するつもりなのか、かかる工数の見積り、開発によるリスク、などなどドキュメントに書き記す必要があります。
・外部設計書
インターフェイスについてなど
・詳細設計書
ロジックについてなど
・テスト仕様書
開発後にテストする項目一覧

これはつまり、なにに使うのかと言えば、社内の承認のためなんですよね。それぞれのドキュメントを添付して、チームリーダー、部長、場合によっては本部長以上の承認をもらうフローになっているので、作る必要があったのです。

これは一言で言えば、くそめんどくさかったです。

だって開発自体は1時間で終わるのに、ドキュメントを作るのに2時間かけて、承認が通るのに1週間とかざらでしたからね。とにかく、ドキュメント作成が基本だったので、承認者も承認作業量が半端なくて回らないという悪循環が生まれていました。こうなってくると、もはや仕事の大部分はドキュメント作成の時間に充てられ、エンジニアってなんだっけ状態です。

これはよくない、ということで今はだいぶ簡略化されたと聞いています。
これのメリットは、大きな企業だったので、サービスを出した瞬間、何万人というユーザーが使い始めるため、小さなミスも許されないという雰囲気があったからだと思います。それはそれでいいですが、このスピードの速いWEB業界で、時に致命的になることもあるかと思います。

スポンサードリンク
ドキュメントなんていらねーだろ派

次に前職では、ドキュメント派とは真逆のパターンで、ドキュメントなんて一切存在していませんでした。さすがにDBのER図くらいは一部あったりしましたが、それ以外は本当になにもなかったです。企画に関しても口頭の同意がほとんどで、エンジニアとデザイナーの共通言語と言えば、ページを絵に書いたラフと呼ばれる画面デザインが唯一の設計書でした。

当然、承認フローがすっとばされるので、スピード感はめちゃくちゃありました。仕様変更があっても、ドキュメントの修正から入ってワークフロー申請して、とかないので、とんでもないスピードでいろいろ変わっていきます。

これはこれで、よかったのですが、後でなにが問題になるかというと、記録が全く残っていないのです。なぜ、この時、こういう仕様になったのか、ここの仕組みがよく分からないから、ちょっと調べたいけど、知ってる人がもう辞めてるので、分からない、みたいなことが頻繁に起こります。新しい人が入ったときに、これ読んでおいて、みたいな資料もないので、長く在籍している人が経験値的に知っているみたいなことが増えていきます。

Wikiレベルでも存在していなかったので、スピードを重視するあまり、ナレッジも溜まってないし、守りが弱くなっているという意味で、第二次世界大戦のゼロ戦みたいな状況ですよ。文化と言えば、文化ですが、新卒で入った子とか、まともに人に見せる常識レベルのドキュメントを一回も書いたことがないってことになるので、それはそれでさすがにどうだろうと思ったりします。そういうのが新卒で入った会社にずっと残るデメリットですね。その会社の常識しか身につけることができないという。

で、ドキュメントは実際、どう扱うのが一番いいのかということなんですけど、なにもないのは後でトラブル調査や引き継ぎするときに、不便なので、なにかしらあったほうがいいと思うんですが、あんまりきっちりやりすぎるとスピード感の妨げになるし、ドキュメントのためのドキュメントになってしまって、意味がなくなってしまう。

というわけで、そのシステムのマスター情報みたいなものを、変更があったら必ず更新される運用フローを構築することが大事なんですかね、あんまりガチガチに縛られない程度に。gitでプルリクするみたいな感じなのかなー。コンフルエンスでもレッドマインでもエサでもいいんですが、最低でも使い易いWikiはあって欲しいですね。

これに関しては、今まで所属したどの会社も最高だという感じじゃなかったので、引き続き、どんな感じがベストなのか模索していきたいと思います。

スポンサードリンク

ABOUTこの記事をかいた人

1983年大分県生まれ。東京在住のWeb系エンジニア。
ポータルサイト、ファッションECサイト、コーディネートアプリ、食品ECサイトの開発運用などを経験。 人に役立つことや面白い記事を書けたらなと思っています。