効率的な社内知識の調べ方
最終更新
最終更新
ウォンテッドリーには大量の社内ドメイン知識が存在します。 それらは業務中頻繁に遭遇するため、はじめに効率の良いキャッチアップ手順を覚えておくとよいでしょう。
社内で何かを調べる際は以下の 3 ステップで調べましょう
現在 Handbook に対する社内フィードバックを積極的に集めています。「欲しい情報が見つからなかった」「知りたいことが知れて便利だった」などは是非こちらの Discussion (internal) にコメントしてください。
Handbook は公開前提で書かれていたり、元々オンボーディング資料として作られていたこともあって社内で一番読みやすいドキュメンテーションになっています。 そのため、New Joiner のオンボーディングや専門外の領域について調べる際はまず初めに Handbook で調べると良いでしょう。 また、検索だけでなく目次をざっと眺めて「こういう概念あるんだ〜」のインデックスを頭に作っておくことも重要です。
ただし特定のチームやマイクロサービスに紐づく詳細情報は Handbook ではなく、個々のリポジトリに記載する運用なので、それらは後述の Backstage を用いて検索してください。
Backstage は複数の Github リポジトリに存在するマークダウンファイルを横断的に検索できるツールです。
Backstage には大量のドキュメンテーションが保存されています。そのため、検索キーワードさえ知っていれば簡単に目当ての情報を得ることが可能です。
一方で、ページ数が多すぎるがゆえ明確な検索キーワードを持っていないと非常に扱いづらいです。 New Joiner や専門外の領域について調べる際は、まずは Handbook で全体像を掴んだ上で個別のトピックを Backstage で検索すると良いでしょう。
Handbook や Backstage を利用すればほとんどの調べ物は行えますが、時には目当ての情報にたどり着けないこともあります。 そんなときは Slack で質問をしたり、過去の Issue/PR を探すことで欲しい情報を探しましょう。
ただし、次回以降も違う人が Slack で質問したり、過去 Issue/PR を探したりするのは非効率です。 ドキュメンテーション化されていなくて困った情報は積極的に PR を作成しましょう。
Slack: #devops_guild
