TOPICS

TECH BLOG

【TECH BLOG #13】エンジニアドキュメントページの経緯と今後 (Funplex Engineer Portal)

#ドキュメント #confluence

ファンプレックス株式会社 エンジニア部 R.Oです。
前回のブログから引き続き、エンジニアドキュメントページのリニューアルを行いましたので、その内容について紹介したいと思います。

おさらい ファンプレックスのドキュメント環境について

前回のブログでもご紹介させていただきましたが、ファンプレックスのドキュメント作成環境は「confluence」(以下コンフル)と言うドキュメントコラボレーションツールを使用しています。

公式ページ:https://www.atlassian.com/ja/software/confluence

今回はファンプレックスのエンジニア向けのドキュメント共有環境についてお話したいと思います。

コンフルはとても便利で社内の資料がかんたんに検索できます。
ただ、膨大な社内の資料から目的の情報を見つけ出すのはなかなか難しく、議事録やスタッフのメモからさまざまな資料が検索にヒットし困ることがよくありました。

DocumentPortalは全員に「共有する用」として専用コーナーを作り、絞り込んだ検索を出来るようにするのが目的でした。
共有ドキュメント環境の保守やサポートのため、新たにDocumentPortal運営チームも結成され、リニューアル方針や実際の対応などを進めていきました。

ドキュメントをツリー構造管理からラベリング管理へ

以前まではツリー構造のままカテゴリーごとに管理していました。


※ドキュメントタイトルは実在するものではありません。

例えば、「Unityでマルチプラットフォームのプッシュ通知導入」という複数のカテゴリーに属すようなドキュメントを作った場合、どのページに置けばいいでしょうか?

ページ階層の区分の整理をすれば回避できるケースもあると思いますが、コンフルの「ラベル」機能を使うことで解決すると考え、「ドキュメントの内容に合わせたラベルと、管理用のラベル(document-portal)を付ける」という運用ルールを作りました。

なので上記の「Unityでマルチプラットフォームのプッシュ通知導入」の場合は「document-portal」「unity」「プッシュ通知」「Android」「iOS」等になります。

コンフルのラベルはマクロ(ページに埋め込める機能のようなもの)も多くサポートしており管理以外にも活用ができそうでした。

また、共有ページすべてに共通のラベルがあることよって「共有ページに絞った検索」「最新の共有ページ」の表示ができるようになりました(検索窓や最新記事はマクロを埋め込んでいます)。


iOSをキーワードに関連ドキュメントを検索
 

ドキュメントポータルの検索性はなぜ必要なのか?
~ 作ってそのままにならないサイクルへの取り組み ~

既存ページの検索方法が不足しているとせっかく書いても見つけてもらえず、活用されません。

他にも、同じ説明のページが生まれる危険性があります。
「Aページ、Bページでだいたい同じだけど微妙に説明が違う」や「Aページは新しい情報だけど、Bページは古い情報」などの問題が予想されます。

そのため、コンフルのラベル機能を活用した検索を導入し、より検索をしやすくしました。

検索性の向上は「間違えた情報」への対策にもなります。

せっかく資料が書けても間違えだらけでは活用は難しいです。しかし、資料は100%間違えなく書き上げるのはとてもハードルが高く難しいです。

活用されないということは間違えたまま放置され、正しいのか間違えかもわからなくなってしまいます。
書いた当時は正解だけど、時間がたって間違えになったなんてことも。

なので「間違えない」よりも「間違えても気が付ける」ような環境が望ましいと考えています。
つまりはいろいろな人の目に入り、気軽に修正出来るようなそんなサイクルが理想だと私は思っています。
間違えを指摘するだけではなく「良い資料をありがとう!ココが間違えていたから、直しておいたよ!」とフォローし合えるような環境が、より良いドキュメント共有環境への近道ではないかと考えています。

最後に

私自身の価値観でお話しますが、エンジニアのスキルとして技術力以外にもアウトプット力みたいなものを感じています。どんなにスキルがあっても「その人にだけ」にできる技術なら、その人はいつかパンクしてしまうと思います。個人が得た知識を別のスタッフに引き継ぎ、それを繰り返してスタッフ全員が技術を使える環境が組織として理想と考えています。みんなが知っている技術ならいつでもフォロー出来ます。もちろん理想論でそんなにうまく行かないとは思います。

誰かに引き継ぐためには「メモ」ではなく「資料(ドキュメント)」として残せる技術が必要になり、それがアウトプット力だと思っています。

今回のDocumentPortalを通じて私自身のアウトプット力を見直し、学ぶ機会につなげられたらと思い、携わらせていただきました。

ドキュメントを残すのはちょっとしたことですが、他のメンバーへの思いやりがとても大切です。共有されるドキュメントがどういったもので、どういったものが喜ばれるか、そういったやり取り、コミュニケーションでより良いメンバー間の協力関係が作れたらと思います。
ドキュメントを通じて社内のメンバーの持つ素晴らしい知識を共有し、ファンプレックスで働くエンジニアの開発力向上と組織への貢献につなげたいと思います。

資料管理などの実績もまったくない私に社内のルールづくりからチャレンジさせてもらえることにとても感謝しています。まだまだDocumentPortalははじまったばかりですが、多くのメンバーに利用してもらって、ブラッシュアップをしていきたいと思います。

ファンプレックス株式会社

グリー株式会社の100%子会社で、ゲーム運営事業を行う。
公式サイト: https://funplex.co.jp/
公式Facebook:https://www.facebook.com/funplexInc

[本件に関するお問い合わせ先]
ファンプレックス株式会社 広報担当
東京都港区三田一丁目4番1号 住友不動産 麻布十番ビル 5階
E-mail: info.funplex@funplex.co.jp