ルールファイル導入で見えた品質と効率の効果
こんにちは、サービシンク生成AI推進活動のルールファイルチームです。
本記事では、私たちが取り組んだ「ルールファイル」に関する活動内容をご紹介します。
ルールファイルとは?
ご存じの方も多いかと思いますが、
「ルールファイル」とは、AI コーディングアシスタント(エージェント)に プロジェクト固有の方針やルールを伝えるための設定ファイル のことを指します。
プロジェクト概要や DB 設計書などの前提知識を Markdown 形式で記述し、エージェントがそれを参照することで以下が可能になります。
- コーディングルールやデータベース構成を理解した上で作業を実行
- プロジェクトに沿った自律的なタスク遂行
イメージとしては「新人メンバーがまず Wiki を読んで作業を進める」ようなものです。
逆に言えば、ルールファイルがないと以下のような事態が起きてしまいます。
ルールファイルがないとどうなる?
例えば、依頼者がエージェントに「〇〇機能を作ってください」と依頼したとしましょう。
- ルールファイルなしの場合
エージェントは与えられた言葉通りに「〇〇機能」を作ります。
しかし、それは依頼者が想定していたルールや仕様を反映していない可能性があります。 - ルールファイルありの場合
エージェントはあらかじめ「プロジェクトの規約や設計思想」を把握しているため、仕様に沿った成果物を出力します。
つまり、ルールファイルがあるだけで「認識のズレ」や「余計な手戻り」を大幅に減らすことができます。
人間同士でも「Wikiに全部まとまっていれば説明が楽」というのと同じイメージですね。
活用したツール
今回の活動では、主に AI エディタ Cursor を利用しました。
他にも Gemini / Claude / Devin / Gopilot などのツールでルールファイルを活用できます。
作成したルールファイル
今回の取り組みでは、実際の開発プロジェクト「エコシステム」を対象に以下5つのルールファイルを作成しました。
- データベース設計書
- 命名規則
- プロジェクトディレクトリ構造と配置ルール
- ログルール
- コーディング規約
※ 実際の内容はプロジェクト固有のため公開はできませんが、骨子としては上記です。
得られたメリット
今回の活動を通じて得られたメリットは大きく分けて 「品質」 と 「効率」 の2点です。
1. 品質の向上
- ルールファイルなし
→ モデルは自身の学習データに基づいて回答。結果、プロジェクトに沿わない出力になる可能性大。 - ルールファイルあり
→ プロジェクトの規約や運用ルールを参照して回答。タスクのアウトプットが一貫し、ばらつきが少なくなる。
▼参考画像
1つ目の例は、チケットタスク実行時の出力です。
Before(ルールファイルなし)では単純に機能実装を開始していますが、After(ルールファイルあり)では「着手時にブランチを作成する」「命名規則に沿ってブランチを切る」といった準備工程を自律的に実行してくれています。
2つ目の例は、コーディング規約を参照したケースです。
Beforeでは一般的なコーディング規約の出力にとどまっていますが、Afterではプロジェクト固有のルール(使用しているプロジェクトのコーディング規約)に従った具体的な内容を提示してくれています。
今回の検証では「ルールファイルを正しく読み込めること」までを目標としたため、実際のコーディングタスク実行までは行っていません。
しかし、ルールファイルを適用した場合には、出力されたコーディング規約に沿ってコード生成を行えることが確認できました。
結果として、成果物の品質が安定しやすくなりました。
2. 効率の向上
ルールファイルがあることで プロンプトの記述量を削減 できます。
- ルールファイルなし
→ 毎回、依頼内容に加えて「前提条件」まで細かく書く必要がある。
→ チャットを切り替えると情報が引き継がれないため、再度同じ説明を繰り返す必要がある。 - ルールファイルあり
→ あらかじめルールファイルとして情報を与えておけるため、毎回細かい前提条件を入力する必要がなくなる。
▼参考画像
今回の比較では短い文章でしたが、実際の大規模開発ではより多くの前提条件を渡す必要があります。
その場合、プロンプトの作成に大きな時間がかかってしまいます。
ルールファイルを活用することで、この入力作業を大幅に削減でき、結果的に「タスクを依頼するまでにかかる時間の短縮」につながると考えます。
苦労した点と改善点
導入段階ではありますが、全く苦戦せず活用できた訳ではありません。
実際に運用する中で以下の課題に直面しました。
- ルールファイルが正しく読み取られないことがあった
- どのケースでどのルールファイルを参照するか明記する必要がある
- 設定の仕方を工夫することで改善可能
- ルールファイルのテキスト量が多いと処理が重くなる
- 分割設計や更新方法の工夫が必要
最後に
今回の活動を通じてわかったことは、
「既存ドキュメントをルールファイルに落とし込むことで、意外と簡単に下地を作れる」 という点です。
そこからは日々のタスク実行を通じて改善を重ね、プロジェクトに合った最適なルールファイルへ育てていくことが大切だと実感しました。
AIエージェントを「頼れるプロジェクトメンバー」として迎えるためには、Wikiにあたるルールファイルを準備するのが近道です。
今後も実践を通じて知見を蓄え、さらに活用方法を広げていきたいと思います。
Webサイト・システムの
お悩みがある方は
お気軽にご相談ください
出張またはWeb会議にて、貴社Webサイトの改善すべき点や
ご相談事項に無料で回答いたします。
