コミュニケーションツールとして生きたドキュメントを作る

最近は何人かで一つの資料を編集することが多い。これはやってみると非常に良くて、なにしろ編集するには読まないといけないから、関わった人皆がドキュメントの内容をそこそこ把握できるようになった。何より、なにかトラブった時に、ドキュメントを拠り所にするようになってきたことが、一番良いことだと思う。

スポンサーリンク

複数人で一つのドキュメントを作成する

最近、といってもここ一ヶ月半くらいのことだが、仕様書を複数人(3人くらい)でよってたかって作るようにした。これが、なかなか良い。作る前と比べて、仕事の進め方がずいぶん良くなったと思う。今作っているものが正しいし、皆もそう理解している、と思えることは、非常にやりやすい。

仕様書といっても、要求・要件だけではなく、打合せの議事録やデモ内容、今後のスケジュールなどを雑多に取りまとめたものなので、仕様がメインコンテンツの一つとなっているドキュメント、くらいのものだ。別に納品物ではないので、特に形式ばってもいない。納品のためではなくて、開発をする自分たちのためのものだ。

生きたドキュメントの必要性

元々、現在関わっているプロジェクトに必要と思われるドキュメントがなく、非常に困っていた。具体的には、知りたいことがのっている仕様書(外部仕様書はあるのだけれど、わかりづらいし、整理されてないし、最新の情報が必ずしも反映されていないし……正直、納品物として納められているだけで、誰も読まない死んだ状態、と思った)や、議事録、これから作ろうとしているものの設計書、等など…。

当然の帰結として、あれってどうなっているんだっけ、というやりとりを何度もすることになったし、なにかすれ違いが発生した時には言った言わないの水掛け論。しまいに何をしようとしてたんだっけ、となることしばしば。いつになったら何ができるのか、の見通しもままならず。生産的ならぬ、凄惨的。

で、このままじゃちょっとまずい、やはりドキュメントをもっとちゃんと作って、言った言わないや希望的観測で物事を進めるのではなく、ドキュメントベースでものを作り、計画をたてていかなければ、と思ったわけだ。

最初は自分が作った部分についてのものをシコシコ作ったりなんだりしたのだけれど、自分一人が作って読むだけでは、なんとも微妙であった。というのも、ドキュメントは作って終わりではなくて、作って、関係者が読んで、読んだ人が改修をして……という一連のサイクルが必要だからだ。関係者が複数人いる以上、一人だけで完結してしまうとなんだかなぁ。

ドキュメントでたいへんなことは、作ることよりも読んでもらうこと、だと思う。ドキュメントは大切ですよね、といえば否定する人はいないのだけれど、なんだかドキュメントを仕事をしたことを証明する領収書のように受け止められているような気がする。特にドキュメントを作る工数云々、と言って作ることを渋る人は、完全に領収書扱いしているんではないかと思う。

本来、ドキュメントはコミュニケーションツールだ。それが生きたドキュメントで、役割を果たして死んだ時に、それは領収書(納品物)として保管される、というのが理想的な状態だろう。

殴り書きの仕様書モドキ

なんとかならんかしら、やっぱり読む量が多いと避けられるのかなぁ、などと考えつつ、殴り書きのメモみたいなドキュメントを、仕様書モドキの名目で、Google ドキュメントで公開した。箇条書きの羅列で、メモ書きみたいな感じですけど、新規開発する機能の仕様書の草案として見といて下さい、程度のノリだ。A4で1,2枚サイズだし、これくらいなら見てもらえるかなー、程度の気持ちだった。

まぁ殴り書きのメモでも、ないよりはあったほうがマシなので、打合せの時にはそれを参照しながら、適宜反映させた。で、決めたことは全部書いていった。ついでに、次のデモの予定なんかも書き始めた。自分一人で全部を把握しているわけではないので、適宜他の人に書いてもらったり、疑問に思うところがあったら、Google ドキュメントの機能でコメントをしてもらったりした。

そんなことを、一ヶ月半ほど続けた。気づくと、いつの間にか仕様書モドキは20数ページになっていた。その中には、要件仕様から画面設計、機能設計、打合せの議事録、デモの内容まで記述されている。仕様の変更があった場合、なるべく早く書き換える、疑問点があったらコメントする、というサイクルが出来上がりつつあった。ちょっと手を加えれば、納品物にもできそうだ。

で、他の機能開発の話では、またドキュメント作らんとあかんね、というような話もしており、なんだか、いつの間にか良いリズムが出来てきたような気がするなー、などと少しばかりの進歩を感じる今日この頃。

モドキ脱却への経緯

まぁ、「気づくと」の4文字でまとめた中に、もちろん色々なことがあった。書くべきことを書いていなくて、やっぱり言った言わないみたいな話になって微妙に険悪な雰囲気になったり、画面設計を曖昧にしていたところが本番で不具合あったり、そんなこんなを繰り返しているうちに、やっぱ書いておくって大事やね、という共通の認識が芽生えてきたのかなぁ、と思う。

いくつかの大小様々なトラブルを経て、なにかあった時にドキュメントが最後の拠り所になる、とわかったのかもしれない。そしてそのドキュメントは、他ならぬ自分も関わっている。

ドキュメントは書くもの

とどのつまり、皆に読まれる生きたドキュメントを作る良い方法は、全員がドキュメントの作成に参加することではないだろうか。きっと、ドキュメントは読むものではなくて、書くものなんだろう。人にドキュメントを読んでもらうのではなく、書いてもらうことが大事なのだ、と思った。

若干の飛躍を覚悟で言うと、この考えはいわゆる”ルール”にも適用できるのだと思う。その延長線上に規約があり、法律があり、憲法があるのだろう。

まぁまだまだ課題は山積なのだが(仕様の策定に追われて自分がコードを書けておらずつらい)、少なくとも一ヶ月前よりもよくなったと思えるのは、素直に前進と考えたい。

ツールについて

ところで、今回チームでドキュメントを作成する上で一番役に立ったツールは、Google ドキュメントであった。MicrosoftオフィスやLibreOfficeも、最近はコラボレーションを意識した機能開発をしているけれど、やはり最初から共同作業を視野に入れているGoogle ドキュメントのほうが安心感がある。OSやソフトウェアのバージョン等、環境をあまり考える必要がないのも良い。ワープロソフトとして機能が必要最小限なだけに(と言いつつアドオン使えば大技もできる)、余計な装飾をせずシンプルにドキュメントを作れて良いと思う。

関連コンテンツ

関連記事

スポンサーリンク

コメントを残す

メールアドレスが公開されることはありません。