ドキュメンテーション Markdown

社内のドキュメンテーションの取り組みと、Kitenのご紹介

ドキュメンテーション Markdown

はじめに

技術部の @june29 と申します。最近の趣味は「お散歩」で、よく晴れた休日には妻といっしょに2時間くらい歩き回ったりしています。この記事では、わたしが2020年から力を入れて取り組んでいる社内におけるドキュメンテーションの活動の一部を紹介したいと思います。

問題意識

もともと、ペパボで働く人々には「書く」という行為が定着しています。現在利用中のサービスを見渡してみると、GitHub、Slack、Google Docs、Scrapbox、Notionなどがあり、常に積極的な読み書きが行われています。

しかし、ドキュメンテーションという観点から見て、すべてが理想的にうまくいっているとは言えない状況であるとも思っていました。具体的には、下記のような課題があると感じていました。

  • 書く場所が何種類もあり、どこになにが書かれているかがわかりにくい
  • 場所ごとにアクセス制限が行われており、どこに書いたら誰に共有できるのかがわかりにくい
  • 「現在も有効な情報」と「すでに古くなっていて現状を表していない情報」の見分けがつかない

社内でアンケートを実施

2020年のある日、わたしと同様の問題意識をもっていた @shikakun @achamixx と合流して、ペパボ全体を前進させるべくドキュメンテーションの取り組みを始めました。

まずは、わたしたちの問題意識が社内の実際の課題として的外れなものになっていないかをたしかめるべく、社内で簡単なアンケートを実施しました。

ドキュメンテーションに関するアンケート

社内全体の約400名を対象に実施したアンケートに100名ほどが回答してくれて、自分たちの問題意識は妥当であろうことが確認できたばかりでなく、自分たちにはなかった視点からの声も多く集まり、やるべきことを明確にしていく上でとても有用な情報が集まりました。

ドキュメンテーションに関するアンケートへの回答の一部

最初に解決しようと決めたこと

「ドキュメンテーション」というと実に広範な課題を扱うことになりますが、はじめから壮大な目標を掲げてしまうとプロジェクトが頓挫してしまいがちなことをわたしたちは経験的に知っています。最初の一歩として「まずはこれを達成する」という小さな的をひとつ決めました。

社内の全員が知っておくべきことで、知らないと不利益が発生してしまう類のものは、すぐに見つかるようにする 💪

2020年は、ペパボがテレワークを基本とする勤務体制へ移行した時期であり、既存の制度が更新されたりあらたな制度が導入されたりして、たくさんの資料が共有されたタイミングでもありました。ときにはGoogle Slidesで、ときにはGitHubのIssueで、さまざまな情報が次々に共有されます。わたし個人も、最新の情報を適切に把握しておくのは大変だと感じていました。これらの情報に、誰しもが必要なときにすぐにアクセスできるようにしたいと願うのは自然なことでした。

Kitenというアプリケーション

先述の目標を達成するために「Kiten開発部」という有志によるチームを組成し、Kitenというウェブアプリケーションをつくりました。

Kiten

Kitenの名前の由来は「起点」と「機転」で、ペパボ社内の情報アクセスの起点として機転のきくものであってほしいとの想いを込めています。主な特徴を下記にまとめます。

  • GHES(GitHub Enterprise Server)のアカウントで認証すると利用できる
  • GHESのリポジトリをバックエンドとして、Kitenはドキュメントビューアーとしてふるまう
  • ドキュメントに対するフィードバック機能を持つ
  • ドキュメントはMarkdownで書き、Front Matterでメタデータを付与する
    • Front Matterで通知先のSlackチャンネルを指定できる
    • Front Matterで「ドキュメントの有効期限」を設定できる

ドキュメントはすべてMarkdownで書かれて連携先のGHESのリポジトリに保存されます。なので、仮にKitenの開発や運用が止まってしまってもドキュメントのデータ自体は簡単に転用できます。社内の人であれば基本的に誰でもPull Requestで変更を提案できます。

コンテンツリポジトリ

それでもあえてMarkdownをそのまま見せるのではなくウェブアプリケーションのガワをかぶせたのは、ドキュメントを「一度書いたら、あとは放置」とせずに、継続的にメンテナンスし続けるための機能を取り入れたかったからです。

Kitenでは、すべてのドキュメントに「提案」のためのフォームが設置されていて、少ない手間でドキュメントのメンテナンスに貢献できるようになっています。また、ドキュメントひとつひとつに通知先のSlackチャンネルを設定できるので、提案があったときに適切な人々にそれが届きます。

ドキュメントに対する提案

今日までの Kiten の運用

2021年3月時点でKitenには約130ほどのドキュメントが存在します。特にHR、経理、総務、法務、広報のドキュメントが充実しており、よく聞かれるような質問はだいたいKitenのドキュメントのリンクを渡してあげれば済むようになってきました。

今日まで活動を継続するにあたっては「Kiten開発部」の他に「Kiten編集部」というチームも組成したのがよかったと思います。編集部は、Kitenにドキュメントを載せようとしてくれる人をサポートしたり、Kitenに載せることで価値を高められそうな既存のドキュメントをKitenに誘致したり、どんなドキュメントを拡充するとよろこばれるかを考えたり、編集の観点で関わってきました。アプリケーションをつくるだけではなく、そこに載せるドキュメントのことまで考えて行動してこれたことで活動全体を推進できました。

Kiten編集部には、開発のはじまりから関わってきた @shikakun @achamixx @june29 に加え、以前から社内の各種ドキュメントを精力的にメンテナンスしてくれていた @monicabunny17 も参加してくれて頼もしい布陣になっています。開発部と編集部という立場を用意することで、開発部としてやるべきことと編集部としてやるべきことを区別して会話できていたのでよかったです。

わたしたちの活動の今後

この取り組みの最初の目標としていた

社内の全員が知っておくべきことで、知らないと不利益が発生してしまう類のものは、すぐに見つかるようにする 💪

は、あらかた達成できているような状況です。しかし、まだまだ「知っている人は知っている便利な情報」はたくさんあります。ペパボには、10年以上も在籍しているメンバーが何人もいて、社内用語といえるような言葉もいくらかあります。自分が新しく入社した会社で、先輩社員たちが自分の知らない言葉をばんばん使って会話していたら、疎外感につながるかもしれませんよね。ドキュメンテーションは、単に業務に必要な情報を整理して作業を効率化するという意義のみに留まらず、オンボーディングにおいては「あなたを歓迎していますよ」という姿勢を示すことにもつながると考えています。

今後もわたしたちはドキュメンテーションの活動を通じて、ペパボのひとりひとりが最高のパフォーマンスを発揮して活躍できる環境づくりを進めていきます。

直近では、4月に入社予定の新たな仲間たちのために手分けしてドキュメントを追加していっています。これまでは「新卒研修用ドキュメント」としてGoogle Slides等で単発の資料として用意されることが多かった各種の情報も、Kitenに載せて継続的にメンテナンスすることで、中途入社の人や既存のメンバーにとっても有益な情報に昇華させていきます。