バイセル Tech Blog

バイセル Tech Blogは株式会社BuySell Technologiesのエンジニア達が知見・発見を共有する技術ブログです。

バイセル Tech Blog

テックブログの品質を担保する取り組み 2024

この記事は技術広報 Advent Calendar 2024の2日目の記事です。

こんにちは、株式会社BuySell Technologiesの吉森 (もりけん / @molmolken) です。
私は昨年の1月にバイセルに入社し、所属している CTO室で技術広報をメインに担当しています。

バイセルについて

バイセルは総合リユース事業を展開する企業です。「人を超え、時を超え、たいせつなものをつなぐ架け橋となる。」というミッションのもと、着物、ブランド品、貴金属、骨董品など幅広い商材の買取・販売を手がけています。社内には100人規模のエンジニア組織があり、リユースプラットフォーム「Cosmos」の開発・運用を行っています。

バイセルで行っている技術広報の取り組みの1つとして、本ブログ(バイセル Tech Blog) の運営があります。具体的には、執筆者への打診、壁打ちの実施、スケジュール管理、記事のレビューなどを行っています。
私は昨年、2023年12月に、『テックブログの品質を担保する取り組み』という記事を執筆し、当時のバイセルのテックブログ運営における以下のような取り組みについて紹介しました。

  • バイセルでは、テックブログの記事が満たすべき要件を明確に定義し、執筆者と共有していること
  • 記事の完成度を高めるため、3段階のレビュープロセスを設けていること
  • 社内の有志メンバーで構成されたワーキンググループが、記事の壁打ちやレビューを分担して実施していること

あれから1年が経ち、バイセルのテックブログ運営はさらなる進化を遂げました。本記事では、この1年で実施してきた新たな取り組みと、それによってもたらされた変化について紹介します。

2024年に新たに始めた取り組み

アウトラインレビューの必須化

2024年の夏ごろから、執筆者との壁打ちを実施した後に記事のアウトラインを作成してもらい、それに対してレビューをするというステップを必ず行うようにしました。

壁打ちのテンプレートにこのようなアウトラインの項目を作っています

この取り組みの背景には、以前から抱えていた課題がありました。それは、初稿が完成した後で、壁打ちで話し合った記事の方向性からずれていたり、重点的に説明すべき箇所のボリュームが足りなかったりする問題です。こういった場合の修正には時間と労力がかかりますし、最悪の場合、記事の書き直しやお蔵入りになってしまうケースもありました。

私自身も含めた多くの人にとって、主張やテーマに一貫性を持った長い文章を書くことは大変な作業です。思うように文を紡げず、最初に考えていた主張からずれてしまったり、本来何を書きたかったのか分からなくなることさえあります。特にテックブログでは技術的な正確性も担保する必要があり、執筆の難易度はより高いと思います。

このような執筆の難しさに対して、アウトラインは羅針盤の役割を担っています。アウトラインがしっかり作成してあると、それを骨子として文章を肉付けをしていけば良いので、当初考えていた主張やテーマと大きくずれることがなくなります。

また、壁打ちでは顕在化しなかった認識のずれを表出化させることもできます。30分程の壁打ちでは記事の内容を細部まで詰めることは難しいので、アウトラインで認識合わせをしておくことで、無用な手戻りを防ぐことができます。実際に、アウトラインのレビューを必須化したことで、初稿を書き上げてから大きく修正が入るということがなくなりました。

チームレビューの実施

昨年の記事で紹介した通り、2023年は執筆後の1次レビューを社内の有志メンバーで構成されたワーキンググループ(以下、WG)が担当していました。

この体制には以下の2つのメリットがありました。

  • レビュー担当を複数人でローテーションすることで一人当たりの負担を減らせる
  • WGにナレッジを集約してレビューの品質を高められる

しかし実際に運用したところ、メンバーの本業が忙しくなりレビューを担当できなくなるとローテーションが破綻してしまい、残ったメンバーの負担が著しく増加するという問題を抱えていました。

そこで、今年の9月からレビュー体制を一新し、執筆者が所属するチームのメンバーや上長に1次レビューを依頼する形にしました。チームの負担は増えてしまいましたが、それを上回るメリットが得られています。

まず、工程がチーム内に閉じたことで、執筆やレビューのタスク管理や工数管理が行いやすくなりました。チームのスプリントやバックログの中で適切に優先順位付けができるようになり、テックブログにかかっている時間が可視化されました。

また、普段からコードレビューを通じてフィードバックを行い合う関係性が築けているため、心理的安全性の高い環境でレビューを実施できています。執筆者に対して過度に遠慮することなく、より良い記事にするための真摯な指摘や提案ができているように感じています。

さらに、レビュアーは執筆者の業務内容や技術的な知見を理解しているため、より具体的で的確なレビューが可能になりました。例えば、「この技術選定の背景にはこういった議論があったと思うので、その辺りについても詳しく書いてみては?」といった建設的な提案や、「この部分はAさんが担当していたXXXの知見も活かせそう」といった視点の広がりを促す指摘ができるようになりました。

このように、チームベースでのレビュー体制への移行は、記事の質の向上だけでなく、チーム内でのナレッジ共有や相互理解の促進にも繋がっています。

CatManuの導入

"CatManu" は、2024年4月に入社した新卒エンジニアたちが新卒研修の一環として開発した、文章のレビューを支援するプロダクトです。テックブログを始めとした文章全般に対して、LinterとLLMを用いた自動チェックを行い、修正案をdiffとして表示する機能を備えています。

特に便利な機能として、修正案と元の文章とのdiffを2カラム形式で色分け表示してくれる点や、各修正箇所に対して git add -p のように個別に適用/非適用を選択できる点があります。なお、内部で有料のAPIを叩いているため、残念ながら社外への公開は行っていません。

左側に2カラムでチェック前後のdiffを表示し、右のダイアログから適用することができます

余談にはなりますが、"CatManu" という名称の"Manu"は「手」という意味で、執筆者に対して「猫の手くらいささやかでもサポートができれば」という願いが込められているそうです。素敵ですね。

機能の詳細やアーキテクチャはこちらのブログの後半「Bチームの取り組みについて」をご覧ください。

ChatGPT を始めとした LLM の普及に伴い、執筆やレビューに LLM を利用することは当たり前になりましたが、効果的な活用にはプロンプトエンジニアリングのスキルが必要です。元から文章を書くのが上手い人は LLM を最大限活用できる一方で、そうでない人とは大きな差が生じているように感じています。
そこで、"CatManu" のような LLM を組み込んだプロダクトを導入することにより、一元管理された最適なプロンプトを誰でも利用できるようになりました。従来の単純な文法チェックを超えて、同音異義語の使い分けや漢字の閉じ開き、文体の揺れなど、より高度な指摘ができるようになり、執筆とレビューの効率が大幅に向上しました。

まとめ

昨年執筆したテックブログの品質を担保する取り組みから1年が経過し、バイセルのテックブログの取り組みは大きな進化を遂げました。具体的にはアウトラインレビューの必須化、チームベースでのレビュー体制への移行、そして24卒エンジニアが開発した LLM チェックツール "CatManu" の導入により、執筆からレビューまでのプロセスが効率化され、記事の品質も着実に向上しています。

これらの取り組みの後押しもあり、2024年9月からはテックブログを毎週公開しています。まだ開始から3ヶ月ほどですが、執筆者およびそのチームメンバー、上長の協力のもと、比較的安定した運用を実現できています。
さらに、年末恒例となったバイセルのアドベントカレンダーも進行中です。バイセルメンバーの多様な知見や経験が詰まった記事が公開されていきますので、ぜひご覧ください。

qiita.com

最後に、バイセルでは一緒にリユース業界の未来を作り上げていくエンジニアを募集しています。様々な職種を募集していますので、ご興味がある方はぜひこちらをご覧ください。

herp.careers