LIFULL Creators Blog

LIFULL Creators Blogとは、株式会社LIFULLの社員が記事を共有するブログです。自分の役立つ経験や知識を広めることで世界をもっとFULLにしていきます。

年末の大掃除として行う開発ドキュメントの「断捨離」

エンジニアの松尾です。LIFULL HOME'S の売買領域でエンジニアのマネジメントを担当しています。

チーム開発やプロダクトの運用をしていくにあたって開発ドキュメントは重要です。LIFULLにおいても日々作成やメンテナンスをしていますが、運用にあたって問題もあります。今回はこれらを少しだけでも改善すべく、「断捨離」に取り組んだ話を紹介します。

ドキュメント管理の現状

LIFULLの開発ドキュメントの大半は下記のいずれかで管理されています。

  • GitHub
  • Google Docs
  • Confluence

GitHubではリポジトリに紐づく補足情報や知識を記載しており、Google Docsは主にミーティングの議事録に利用されていることが多いです。これらの中では大きな問題は発生していない認識です。

Confluence も職種を問わず全社員が利用できるツールとして、開発ドキュメントだけではなく多くの用途で活用されています。誰でも利用できる便利さがある一方で、いくつかの問題があります。

  • ページの重複があり、公式寄りの情報がわかりづらい
  • 更新されていない情報も含めてページの総量が多い
  • 個人スペースに有益な情報があるときもある

このような問題の一部を「断捨離」のイメージで解決できないかと考えました。

「断捨離」の意味

「ものを捨てる」文脈で利用されることが多いことばですが、実際には「ものを捨てる」は「断捨離」の一部分を切り取ったものです。「断捨離」の起源はヨガの哲学にある「断行」、「捨行」、「離行」であるそうです。

  • 断行: これから入ってくる不要なものを断つこと
  • 捨行: 既存にある不要なものを捨てること
  • 離行: ものへの執着から離れること

開発ドキュメントの「断捨離」

そこで、ドキュメント管理の問題に「断捨離」の動きを当てはめてみました。

  • 断: 重複ドキュメントをまとめて増えないようにする
  • 捨: 不要なドキュメント/記載を削除する
  • 離: 個人スペースにあるドキュメントをあるべき場所に置く

これらを「断捨離」の実践例として、問題解決に取り組んでみることにします。

Googleのソフトウェアエンジニアリングにおいても、「カノニカルな情報源の確立」が重要であると述べられています。組織全体で使える中央集権的なリファレンスを目指していけるように、まずは個人レベルでの行動を促してみます。

年末の大掃除

気付けばもう12月です。株式会社サーバーワークスの事例 も拝見し、「年末の大掃除」を称して開発ドキュメントの断捨離に取り組んでみることにしました。

LIFULLには部署の社員で集合して行う総会の文化があり、部署ごとにさまざまなコンテンツでの実施をしています。今回は私が所属しているプロダクトエンジニアリング部2Uの総会の場で、個人ワークとグループワークを行いました。

個人ワーク

前述の開発ドキュメントの「断捨離」を実践例として、まずは自分の手元にのメモ/ドキュメント類を整理してもらいます。時間に余裕があれば所属するグループや組織に関連するページについても見てもらうことにしました。

グループワーク

各自が行ったことを共有しあってもらいます。コミュニケーションと割り切って気楽に話してもらうのがメインですが、「実はそのページ消しちゃダメかも…?」というような万一の抑止が入ることも狙っています。

試してみた結果

15名程度で実際に取り組んでみた結果、実践例やツールを問わずさまざまな動きが見えました。

  • ゴミ箱、ダウンロードフォルダなどパーソナルなスペースからのファイル削除
  • 自身のまとめで有用そうなファイルを技術横断のスペースに移動
  • 必要なドキュメントの情報の最新化
  • Slackチャンネルからのリンクの精査
  • 現在時点では未使用のツールのドキュメントをアーカイブ化

「断」でしくみを整えることは、対象や影響範囲が大きい場合は難しいこともあり今後の課題と感じました。とはいえ怪しいドキュメントに「非推奨」とラベルを付けるだけでも効果はありますし、捨てられず量が増えても効率化する手段はあると思います。

ゴミ箱やダウンロードフォルダからの削除はセキュリティリスクを鑑みてもあらためて重要であり、定期的に整理の時間を取ることが望ましいと思います。年末の大掃除は理にかなっていそうですが、年1回と言わず適切な頻度で見直すのが良さそうです。

まとめ

年末の大掃除にかこつけて、開発ドキュメントの整理に取り組んでみました。たった1時間の取組みなので大きな成果とは言えませんが、これを第一歩として組織全体で「断捨離」の文化を作っていければと思っています。

最後に、LIFULL ではともに成長していける仲間を募集しています。よろしければこちらのページもご覧ください。

hrmos.co

hrmos.co