<p>DIGGLE株式会社でエンジニアリングマネージャーをしている岡崎と申します。普段はエンジニアチーム全体のマネジメントを担いつつ、開発業務も行っています。DIGGLEは予実管理クラウドサービス「<a href="https://diggle.jp/" target="_blank" rel="noopener noreferrer nofollow">DIGGLE（ディグル）</a>」を提供するスタートアップであり、「<a href="https://rubykaigi.org/2023/" target="_blank" rel="noopener noreferrer nofollow">RubyKaigi 2023</a>」の<a href="https://rubykaigi.org/2023/sponsors/#sponsor-498" target="_blank" rel="noopener noreferrer nofollow">スポンサー</a>を担うなどテクノロジーやそのコミュニティへの投資を積極的に行っています。本記事ではDIGGLEのエンジニアチームが、どのように技術的負債解消を行っているかについてご紹介します。</p><h2 id="h48ed43c917"><strong>工数の何%を負債解消に充てるかを四半期ごとに経営と合意する</strong></h2><p>技術的負債解消は、エンジニアチーム単体でやり切るにも限界があり、経営陣の理解を得ることが重要です。弊社はCTOが共同創業者であるため、エンジニアの意見が経営陣へダイレクトに届き、経営陣の技術に対する理解度が非常に高いのが特徴となっています。CTOから技術的負債がビジネスに及ぼす影響を経営陣に説明することで、技術的負債解消の重要性を経営陣も理解し、技術的負債解消に対して一定の工数を割くことができる状態になっています。</p><figure><img src="https://images.microcms-assets.io/assets/a305d34415d64c7cb069450481b6130c/90021b12fa5c4ad2b95ae2b93b342a63/image4.jpg" alt="" width="1920" height="1290"><figcaption>CTOがProductチームと経営陣のハブとなっている</figcaption></figure><p>実際にどの程度の工数を割くかについては、四半期ごとに、私とCTOで技術的負債解消に割り当てられる工数の目安を相談して決めています（おおよそ20%程度に収まることが多いです）。</p><p>このような仕組みにすることで、技術的負債を会社全体の関心事として捉え対応することが可能となり、「日々の作業が忙しくて技術的負債解消を行うことができない」という状態に陥らないようにしています。</p><p>実際に、技術的負債解消の中で解決した問題を弊社のエンジニアブログで取り上げていますのでご紹介します。</p><p><a href="https://diggle.engineer/entry/fixed-issue-railsapp-caused-by-updating-ruby31-to-ruby32" target="_blank" rel="noopener noreferrer nofollow">Ruby のバージョンを 3.1 系から 3.2 系にアップデートしたら Ruby on Rails アプリの動きが変わったのを解決した話</a></p><p>DIGGLEでは経営陣に技術に対する理解があるためこうした体制を実現できていますが、読者の中には「なかなか経営陣に技術的負債解消の重要性を理解してもらえない」という環境の方もいらっしゃるかもしれません。</p><p>その場合は、臨機応変に可能な限り権限が高い方（CTO、部長、リーダーなど）と技術的負債解消の重要性を共有し、組織やチームで継続的に技術的負債に対応できるように働きかけていくことから始めると良いと思います。</p><p>そして、技術的負債の解消により得た実績（工数が削減した、バグが減少したなど）を収集することで、技術的負債解消がどのような好影響を与えたかを定量的に測れる仕組みを作ることが肝要となります。そうして計測した数値を基に、経営陣と根気強く対話をし、ゆくゆくは会社全体で技術的負債に立ち向かえる環境にしていきましょう。</p><p>参考までに、弊社で計測している数値をご紹介します。弊社では以下の数値などを四半期ごとに計測し、CTOを含む開発チーム全体で状況を共有する仕組みを作っています。</p><ul><li>どの作業にどのくらいの工数が掛かったか（新規機能開発 / 既存機能改善 / 技術的負債解消 など）</li><li>本番環境でどのようなバグが発生したのか（インシデント / デザイン崩れ / 軽微なバグ など）</li><li>上記のバグ対応でどのくらいの工数が掛かったか</li></ul><h2 id="h374361b6fc"><strong>開発作業の終わりにリファクタリングを行う文化</strong></h2><p>弊社のエンジニアチームには、開発作業が終わったタイミングでリファクタリングを行う文化があります。</p><p>これは私が社員3人目として入社した2019年当時から存在しているのですが、開発作業が終わってPull Requestを投げる前に、リファクタリング用のタスクを切って、コードの整理やテストコードのバリエーション追加などの対応を各エンジニアの裁量で行う文化です。</p><p>これにより、常日頃から各エンジニアが個人レベルで意識を持って作業し、「そもそも技術的負債がたまりにくい土壌」が作られています。</p><figure><img src="https://images.microcms-assets.io/assets/a305d34415d64c7cb069450481b6130c/b13cf930af924a2a8cbdcef3f932f86e/image8.jpg" alt="" width="1417" height="643"></figure><h2 id="hfea3fe6791"><strong>TODOやFIXMEを放置しない仕組み</strong></h2><p>エンジニアの皆さんは共感してくださると思うのですが、ついつい書いておきたくなってしまうTODOやFIXMEは、時間が経って数が多くなってくると以下のような問題が起こります。</p><ul><li>多過ぎてどこから手をつけてよいかわからず、結局放置する</li><li>時間が経ち過ぎて、書いた本人すらどんな内容だったかを覚えていない</li><li>コメント量が少なくて、そもそも何に対するTODO / FIXMEなのかがわからない</li></ul><p>弊社では、これらの解決策として「TODOやFIXMEを書く場合はJIRAにタスクとして挙げ、TODOコメントにはJIRAのリンクを記載する」というルールを作っています。これにより、先ほどの問題点は以下のように解決することができます。</p><ul><li>多過ぎてどこから手をつけてよいかわからず、結局放置する<p>→常日頃使っているJIRA上でタスクとして確認することが可能になる</p></li><li>時間が経ち過ぎて、書いた本人すらどんな内容だったかを覚えていない</li><li>コメント量が少なくて、そもそも何に対するTODO / FIXMEなのかがわからない<p>→JIRAの本文に背景・内容を記載することで把握ができる</p><p>→バックログリファインメントで新規JIRAタスクを確認する際に、背景・内容が理解できるものになっているかチェックすることができる</p></li></ul><p>上記運用に際して、Pull Requestレビュー時に目視でチェックすることは難しいため、TODOやFIXMEにJIRAリンクを付けていないとエラーになるようにCIを組んでいます。</p><figure><img src="https://images.microcms-assets.io/assets/a305d34415d64c7cb069450481b6130c/fa06a9c72c4042138f0afb4a685dce92/image5.png" alt="" width="1207" height="218"></figure><p>参考までにrubocopのソースコードを添付します。</p><pre><code class="language-ruby">class TodoComment &lt; RuboCop::Cop::Base
  include RuboCop::Cop::RangeHelp

  MESSAGE = &apos;Annotation comment, with keyword `%&lt;keyword&gt;s`, should have JIRA TASK (ex: DEV-N).&apos;.freeze

  def on_new_investigation
    processed_source.comments.each_with_index do |comment, index|
      next unless first_comment_line?(processed_source.comments, index) ||
                  inline_comment?(comment)
      annotation = RuboCop::Cop::AnnotationComment.new(comment, keywords)
      next unless annotation.annotation?
      next if jira_task?(annotation)

      register_offense(annotation)
    end
  end

  private

  def register_offense(annotation)
    range = annotation_range(annotation)
    add_offense(range, message: format(MESSAGE, keyword: annotation.keyword))
  end

  def first_comment_line?(comments, index)
    index.zero? || comments[index - 1].loc.line &lt; comments[index].loc.line - 1
  end

  def inline_comment?(comment)
    !comment_line?(comment.loc.expression.source_line)
  end

  def annotation_range(annotation)
    range_between(*annotation.bounds)
  end

  def jira_task?(annotation)
    annotation.comment.text.match?(/DEV-\d+/)
  end

  def keywords
    %w[TODO FIXME]
  end
end</code></pre><h2 id="h92a239a3a7"><strong>ライブラリのアップデートを、SaaSを使って自動で行う</strong></h2><p>弊社プロダクトは主にRuby on RailsとReactで構成しているのですが、gemやnpmなどのアップデートは<a href="https://depfu.com/" target="_blank" rel="noopener noreferrer nofollow">depfu</a>というサービスを使って、自動でPull Requestを作成する仕組みにしています。</p><p>depfuで作成されたPull Requestについては、逐次対応するのは大変なので（後述のセキュリティアップデートは異なります）、3カ月に1回、エンジニアチーム全体で分担してdepfuが作成したPull Requestの確認と、必要に応じた修正をしています。</p><p>セキュリティアップデートについては、即対応が求められるものとなりますので、毎朝Slackに通知を飛ばします。アップデートがある場合は、デイリースクラムで担当者を割り当てて即日中にリリースするような仕組みとなっています。</p><figure><img src="https://images.microcms-assets.io/assets/a305d34415d64c7cb069450481b6130c/8f995f55d8f143b2b0aec5cd37ef86f6/image7.jpg" alt="" width="565" height="225"><figcaption>Slack上でのセキュリティアップデートの通知キャプチャ</figcaption></figure><h2 id="h447e0f8f3a"><strong>OSのミドルウェアアップデートは週次で自動実行する</strong></h2><p>次にサーバーのOSミドルウェアのアップデートについてですが、弊社ではAWS Fargateを利用し、Docker imageを使ってリリースしていますので、Docker image内でのライブラリアップデートをどのように行っているかについてご説明します。</p><p>各サーバーが利用しているDocker imageに関しては、CIにより週次でライブラリのアップデートを行っており、各エンジニアが意識することなく、日々のデプロイを行うタイミングで最新のライブラリが自動適用されるようになっています（もちろん、試験環境で動作検証を実施してからリリースを行っています）。</p><figure><img src="https://images.microcms-assets.io/assets/a305d34415d64c7cb069450481b6130c/009be8374642472984c853378494c3c4/image2.png" alt="" width="1067" height="674"><figcaption>週次でDocker imageを更新しているGithub Actionの図</figcaption></figure><h2 id="h27325700b4"><strong>バグやSlow Queryを自動検知する</strong></h2><p>弊社では<a href="https://www.bugsnag.com/" target="_blank" rel="noopener noreferrer nofollow">Bugsnag</a>というサービスを使って、バグが起きた際にSlackへ通知を飛ばす仕組みを作っています。バグについては、営業時間内であれば即時、営業時間外であれば次の営業開始時に確認します。そして、この仕組みに相乗りする形で、Slow QueryについてもBugsnag経由でSlackに通知が飛ぶように設定しているので、同じフローで確認ができるようになっています。</p><figure><img src="https://images.microcms-assets.io/assets/a305d34415d64c7cb069450481b6130c/b3dd7aa7c2884c3abdcd593a2d983e8d/image6.png" alt="" width="814" height="396"></figure><h2 id="h97864f4768"><strong>積極的に自動化やシステム化をする</strong></h2><p>技術的負債解消に限ったことではありませんが、弊社では、前述したように自動化できるものは積極的に自動化しています。そして、自動化できないものについてもスクリプトを組むなど、なるべく人が行わなくて済むような仕組みを構築することを重要視しています。</p><p>自動化・スクリプト化する理由としては、工数削減と、ルール化・仕組み化の抑止の2つが挙げられます。</p><h3 id="h905af46c97"><strong>工数削減</strong></h3><p>こちらは想像しやすいと思いますが、自動化することにより手作業で実施するよりも工数を削減することができます。これにより、エンジニアの対応が必要な技術的負債解消に注力することが可能となります。</p><h3 id="h2e318cd4ca"><strong>ルール化・仕組み化の抑止</strong></h3><p>定常的に何かをチェックしたり、対応したりする必要があるものについて、手作業で対応を行う場合、チェック表であったり、手順書であったりを作成することになると思います。そういった資料を用いつつ、ルールや仕組みを作って運用していくのですが、1つ2つであれば問題ないものも、数が多くなってくると把握が難しく、窮屈に感じるようになってしまいます。</p><p>そのため、弊社では可能なものについては自動化・スクリプト化し、ルールや仕組みをなるべく増やさないように心がけています。</p><p>上記2点の結果として、余分なところに貴重なエンジニアのリソースが割かれてしまうことを抑止できます。効率よく必要な箇所へ工数を注入することができるようになり、それが日々増えていく技術的負債に対する特効薬となります。</p><h2 id="h3bcda3e6b0"><strong>最後に</strong></h2><p>以上、DIGGLEにおける技術的負債解消方法を、いろいろな切り口でご紹介しました。</p><p>技術的負債はエンジニアを苦しめる問題であり、技術的負債が多ければ、それだけエンジニアの職場環境は悪いと言えます。そして逆に言えば、技術的負債の解消はエンジニアの職場環境改善の一助となります。</p><p>この記事が、読んでくださった方の職場環境改善の一助となることを願い、本記事を締めさせていただきます。</p><p></p><p>編集：中薗昴</p><p>提供：<a href="https://haulinc.jp/" target="_blank" rel="noopener noreferrer nofollow">株式会社Haul</a></p>

予実管理クラウドサービス「DIGGLE（ディグル）」を提供するスタートアップ企業DIGGLEのエンジニアチームが、どのように技術的負債解消を行っているかについてご紹介します。

「DIGGLE株式会社」の記事一覧