ドキュメントこんにちは、インフラの天津です。Cloudへのアウトプット数を確認して可視化してみた話をしようと思います。やったかエンジニアとしてアウトプットが大事なのは言うまでもないことです。自分が所属しているチーム(前回記事参照)でもアウトプットを推奨していますし、がんがんドキュメントを起こして更新しています。実態として「どれくらいの量なのか」という疑問は残っていました。そこで実態を計測して可視化し、あわよくばチームの指標の1つとして活用したいと思いやってみました。先に結論なのですが、いい感じに可視化ができました!そして自分たちのチームがどれくらいのアウトプットをしているのかが把握できました。今回のゴール始めたときには下記を考えていました。Confluenceのアウトプット数を取得する。いい感じに可視化する。何をどうしたかでは、何をどうしたかを説明していきます。そもそもConfluenceに機能があるか?Confluenceにそもそも機能があれば使えばよいだけなので確認しましたが、Premium版にしか無いようです。Confluenceなので自作の道へ進みます。作ってみるまずは大まかな設計です。APIでスペース毎のコンテンツの作成者が取得できることがわかったので取得してみました。API今回はbashスクリプトで実装します。ページネーションの実装も必要ですね。>contents.jsonこのような感じです。実行したところ結果のjsonがいい感じに取得できましたが、作成のみではアウトプットとは言えないのでは?という疑問がでてきました。アウトプットとは何かを考えたアウトプットとは?と考えましたが、今回はシンプルに早めにゴールを達成したかったので下記2つをアウトプットと捉えることにしました。更新データの取得Confluenceにはバージョン管理機能があり、ページを更新(publish)した際に版数と更新ユーザが記録されるのでそちらも取得することにします。APIでコンテンツ毎の更新者が取得できることがわかったので取得してみます。スクリプトはこんな感じになりました。>versions.json実行したところページごとの全バージョンの更新者が取得できました。データが一旦揃ったので可視化してみます。driveにアップロードしましょう。APIのresponseデータは下記のようなフォーマットです。{}}データポータルにてアップロードしたspreadsheetをデータソースにして可視化してみます。(このあたりは説明を省略しますが、Gsuiteをお使いであれば情報も多いので簡単にできると思います。)可視化にあたっては時系列での状況と、個人別の状況、チームの状況が一覧できるようにしてみました。出来上がったのはこのようなダッシュボードです。いい感じになりました。A君の更新数が半端ないです。(自分は更新数では2位でした。)個人の更新回数や、ページ作成数も時系列で確認できます。チームでの各数値もサクッと作れました。可視化でわかったこと今回可視化してみてチームの2019-04-01〜2020-01-31までの状況がわかりました。平均100件/週、合計4,000件弱もちろん作成や更新の数が全てとは言えないのですが、現在のチーム状況と照らし合わせて1つの指標として活用できそうです。(たとえば更新が25件/週以上かどうかウォッチするなど。)また、チームメンバーがいずれも多くのアウトプットを残していることを改めて実感できました。他にわかったことConfluenceのAPIはページネーションもあり、今の作りでは少し時間がかかるので高速化も考えないと実用に耐えない状態です。質の測定これはやってみたいですが、ドキュメントの質の測定方法は数字で表すには様々な意見がありそうでして、ハードルが高いなと感じています。なにかいい方法をご存じの方がいらっしゃいましたらぜひ教えていただきたいです。実際のエンジニアの仕事としてはコードも重要ですよね。リポジトリのコミット数、コメント数なども含める必要があると思っています。現在は手動での実行になっているので定期的に実行し蓄積していきたいです。具体的には何らかのジョブスケジューラを使用し、BigQueryあたりに蓄積できればいいかなと思っています。今回はチームのメインのスペースのデータのみ収集しましたが、他の部署の状況なども知ることで自分たちの状況をより把握できる気がしています。先に書いた高速化と合わせて行えればなと思います。今回時間がなく手がつけられませんでしたが、下記のようなコンテンツのメタデータやコメントなどを含めることで更に意味のあるデータになるかな?と感じています。今回は以上になります。Confluenceをお使いの方はぜひ参考にしていただければ幸いです。今後のブログでこの後についてもご紹介できればと思います。最後までお読みいただきありがとうございました。http://blog.e...2019-06-21AnsibleとShellでALBのTargetGroupのWebサーバのデーモンを再起動するこんにちは。ご存知じゃないかと思いますが...2017-10-06Pythonで為替のテクニカル指標を可視化はじめまして、2017年新卒システムエンジニアの鈴木です。(1)ABOUT株式会社アドウェイズのエンジニアによるブログです!このブログでは、アドウェイズのエンジニアがざっくばらんに技術のことや日常生活について書いていきますので、みなさんよろしくお願いいたします。アドウェイズ中途採用情報スターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。