開発Wikiについて
当記事をご覧いただきありがとうございます！
皆さんWikiという単語を目にしたことがあるかと思います。一定規模の会社であれば社内の情報やノウハウを蓄積・共有するツールとしてWikiがある場合が多いのではないでしょうか？
弊社では開発内でWikiが整理されておらず、情報が属人化されていたり、新しい人が入社した時にキャッチアップに時間がかかってしまうという課題がありました。そのため、Wikiを整理・充実させて課題を解決しようとする動きが2024年に入ってから始まりました。
開発Wikiのプロジェクトが半年ほど経ち形になってきたので、現状や課題・これからどうしていきたいかを記事にまとめました。
開発Wikiの位置付けと内容
開発Wikiといっても目的によって多種多様なことが書かれているかと思います。弊社では属人化の解消と、オンボーディングの資料などがまとまっている状態を目標にしており、そのために必要な情報を書き記すようにしています。
開発Wikiは次のようにサービスごとに分けています。
こういったサービスごとに次のような資料をまとめています。
- オンボーディング資料
- 開発資料(アーキテクチャやテスト・リリースなど)
- その他項目(ドキュメントや運用・Q&Aなど)
現状とその効果
開発Wikiをはじめとする社内Wikiは日々更新をしていくので、完成の状態はありません。その上で、当初の目的である属人化の解消がどれほどされているかやWikiの充実度という観点で言うと、進捗率は体感60%ほどかなと思います。
まず、オンボーディング資料に関してはサービス概要や開発環境・環境構築の方法などの最低限の情報は記載されています。以前はgithubやNotionなど各場所に資料が点在していて、入社してきた新人の方がどこを確認すれば良いかが一目でわからない状態になっていました。これが解消されたのは大きい効果だと言えます。
開発資料に関しても一部機能が不足していますが概ね必要な情報が記載されている状態になっています。その他項目に関しては必要に応じて追記しているのが現状です。これによって担当者でなくとも仕様が理解できたり、デプロイやロールバック手順が統一されたりという効果が出ています。
課題と今後良くするために
現状の課題は、機能の記載が不十分であることと用語の統一がなされていないことです。社内用語は部署ごとに呼び名が違ったり指すものが違ったりしている問題があります。
今後より良くするためには、以下の2つが必要だと思います。
- 機能充実
- 整理と改善
機能充実に関しては言葉の通りで各サービスで必要な機能仕様や社内用語を加えていくことです。十分な情報が揃っているわけではないので「情報にアクセスできる」という状態にすることが必要です。また、必要に応じて用語の指し示すものを一意にし、新人も理解しやすい状態を作ることが必要です。
次に必要なことは整理と改善です。「情報にアクセスできる」という状態になった後は「情報にアクセスしやすい」という状態にすることが必要です。不要な情報のアーカイブや各項目の整理・各項目で何を書くかや目的を記載するなどWikiとしての完成度をさらに高めていきたいと思います。
また、参考として次のような社内Wikiの改善に向けた動きを参考に、社内Wikiのポリシーの導入やアーカイブ集の作成・ドキュメントオーナーを設けたりすることでより良いものが作れるのではないかと考えています。
まとめ
今回は弊社の取り組みの一つである開発Wikiの記事を書かせていただきました。弊社はベンチャーでまだまだ未整備のカオスな部分もありますが、Wikiをはじめとする様々な整備を進めており、過渡期であるなと感じることも多いです。こういった試行錯誤を重ねながら組織をよりよくしていくフェーズに興味がある人にはピッタリだと思います。
ユーティルでは事業成長を助けるエンジニア仲間を探しています。この記事を見て面白そうだな、やってみたいなと感じた方は弊社にピッタリだと思います！
もしご興味をお持ちいただけましたらぜひ、開発部一同お待ちしております。