更新され続けるEngineering Handbookのために

こんにちは。アルバイト事業部エンジニアのmnmandahalfです。

私たちは積極的にエンジニアの仲間を募集していますが、もっと私たちの組織・文化・利用技術について知ってもらおうと思いLivesense Engineering Handbookというものを作りました。 *1

Livesense Engineering Handbookについて
エンジニア採用資料作成における一般的な課題
課題の解消のために工夫した点
Join us!

Livesense Engineering Handbookについて

livesense-inc.gitbook.io

こちらはGitBookにホスティングされている、エンジニア採用における広報を目的に作られた資料です。主にスカウトやSNS、カジュアル面談を通じて出会った採用候補者の方や、新入社員の方向けの資料となっています。

カジュアル面談にいらした方よりも少し広めの層にリーチする目的で、リブセンスでエンジニアとして働くことの概要がわかるような形で書かれています。

この資料は常に鋭意執筆中であり、「自律共創」のコンセプトを体現するために、リブセンスエンジニアであれば誰でも簡単に編集可能となっています。

エンジニア採用資料作成における一般的な課題

こういった採用資料を作る上で、一般的に考えられる、そして実際に過去に弊社が抱えていた課題には以下のようなものがあります。

EMや人事など一部の個人が更新しており、気づいたら退職などでメンテナンスが宙ぶらりんになる
そもそも資料の存在自体知られていない
内容が古くなっているのを見つけたが、誰に報告すればいいのかわからない
新しい取り組みを始めたことをアピールしきれない
技術用語のtypoを見つけたが、小さなことなので指摘して直してもらうのも気が引ける

まとめると継続的なメンテナンスがしづらい点と言えるかと思います。

課題の解消のために工夫した点

GitBookの採用、Pull Requestでの更新

まずはGitBookを採用したことです。GitHub → GitBookへの連携を行うことで、GitHubへのPull Requestベースで更新ができる点が最大の魅力でした。PRをmainブランチにマージするとGitBookの公開ページが更新されます。

対抗としてNotionの採用も検討しましたが、使い慣れたUIでエンジニアなら誰でも気軽に編集とレビューを通じた議論ができる点が、継続的なメンテナンスの鍵だと私たちは考えました。

レビューは社内のエンジニア数名からなる情報発信チームで行っており、SlackやGitHub上で議論を重ねながら執筆活動を行っています。

PRレビューや対面でコメントしてくださった人も含めて多数の人に貢献してもらい、このHandbookは成り立っています。

SaaS版のGitBookを使っていますが、連携したリポジトリにPull Requestを出すとプレビューが生成される点も魅力です。

GitHub Actions + textlintでの校正

GitHubで更新ができるということで、GitHub Actionsが利用できるというメリットもあります。GitHub Actionsでは textlint で文章の校正を行っており、textlint-rule-prhを利用して技術用語の表記揺れ（◯: Elasticsearch ×: ElasticSearch など）もチェックしています。レビューの工数が減らせるため、より気軽でスピーディーな更新が可能になります。

現状表記揺れのデータは溜まっていないため、PRテンプレートで表記揺れを発見した方に辞書にあたるymlファイルを更新するよう呼びかけています。

まだ自分たちに合ったtextlintルールや表記揺れ辞書の効果的な運用方法は模索中ですが、ノウハウがたまったら公開したいと思います。

定期的なリマインドやアクセスを促す仕組み

継続的に更新し続ける工夫としては、Slackでリマインダーを設定してエンジニアの集まるチャンネルに通知を送ったり、社内Wikiやこのブログのメニューなどに動線を設置したりすることでアクセスを促しています。また、GitHubのPRに関する通知もSlackに送っています。忘れたくないことは機械に覚えていてもらうのが一番ですね。

折に触れてLivesense Engineering Park等で話に出すことで存在を思い出してもらえるようにもしています。