見出し画像

ドキュメント文化が芽吹くまで

TeamUpでは、本格的にドキュメントを書き残し始めてから約4ヶ月が経ち、今では400件近いドキュメントが生成されています。カテゴリーに分けると、だいたい以下の6つの話題が多いかなという感じです。

・仕様書
・議事録
・営業ログ
・ことはじめ系(「○○の使い方」とか「○○を導入ガイド」とか)
・メンバー紹介
・日記/独り言

ドキュメントを残そうと思ったきっかけ

TeamUpの開発チームでは、以下のような事件が頻発していました。

・誰かに聞かないと仕様がわからない
・つくっている途中で目的を見失う
・余計な機能が生まれる(もっとミニマムでもリリースできたのに)
・環境構築が終わったらあとは野放し(for 新メンバー)

しかし、これでは本当につくるべきものにフォーカスできません。この状況を打破するために、チームとして積極的にドキュメントを残す方向で進み始めることにしました。

---

集約する場所を決める

「ここに溜めます!」と言い切ることがまず大事です。

以前は、Googleドライブを使ったり、GithubのWikiを使ったり、個人のEvernoteの共有リンクを発行したりしてドキュメントを管理していました。しかし、それでは検索性が非常に悪く、せっかく新しく書こうと思ったときにも「どこに書けば良いのか」を考えるだけで無意味に疲れてしまい、そのまま書くのをやめる、、、というようなことも起きていました。

TeamUpでは、メンバーのおすすめでesaを使うことにしました。

テンプレートを活用

新しい習慣を始めるときによく言われることですが、「ハードルを下げる」ことは非常に重要です。例えば、テンプレートを活用することで「えっと、何から書けば良いんだっけ」という状態を避けることができます。

例えば、私のチームでよく活用されている、仕様書テンプレートはこんな感じです。

【仕様書テンプレート】
・概要
 ・なんのためにつくるのか
 ・誰のためにつくるのか
 ・どういうユーザー体験が実現されるべきか
・詳細
 ・URL
 ・機能仕様
 ・データ構造
 ・その他

何か新しい機能をつくるときや、機能を変更する時には、上のような項目に従って仕様書を書くようにしています。これを書くことによって、つくる目的が常に明確になるため、実装終盤でのちゃぶ台返しが本当になくなりました。

少し話が逸れますが、「どんなユーザー体験が実現されるべきか」はクックパッドさんの事例を参考にし、絵文字を活用しながらユーザーが使っている様子をはっきりとイメージできる形で書くようにしています。

デザイナーだけではなく、エンジニアもこの部分を積極的に書いてくれています!

気持ちレベルからオープンに

情報がオープンであり、誰でも編集できるからこそ、完成度10%でも書き残しておくことに価値があります。足りなければ他のメンバーが書き足しておいてくれるので大丈夫です。

ドキュメントと言うと、今後チームの多くの人が読むものであり、つい「ちゃんと書かなきゃ」と思ってしまうかもしれないのですが、その心配は必要ないかなと思います。

例えば、私のチームでは「自分が今考えていること」や「○○における問題点」など、気持ちレベルの投稿が時々あがってきます。

これによって、書いている本人は頭の中が整理され、それを読むメンバーは今その人がどんなことを考えているのかがわかります。さらに、そういった投稿は解決策を真剣に考えるタイミングで非常に役に立ったりします。

チームで合意されたタイミングで、テンプレートを活用しながら読みやすい形に整えられれば十分なので、何かが発生した瞬間に文字にして残しておく癖をつけ、なかったことにならないようにする空気感がつくれると良いと思います。

まとめ

どこに書けばいいの? → 集約する場所を決める
何を書けばいいの?  → テンプレートを活用
いつ書けばいいの?  → 気持ちレベルからオープンに

という3つの視点でポイントをご紹介しました。これらの疑問や不安を解消することで、ぐっと文化にしやすくなります。

最後に、筆者の感覚的な意見なのですが、ドキュメントがあるとサービス開発における安心感が全く違います。たしかに、ほとんどのことは聞かなくてもわかるので、会話は減るのですが(笑)、チームで同じものをつくっていくという気持ちはより強いものになったのかなという感じがします。

この記事が気に入ったらサポートをしてみませんか?