ForgeVision Engineer Blog

フォージビジョン エンジニア ブログ

Kiroで実行ログ、ドキュメント、コードコメントを全て日本語で出力する

こんにちは、AWSグループの山口(@kinunori)です。

AWSからリリースされた Kiro はご存知ですか? KiroはVibe Codingだけではなく、プロンプトから要件を一緒に考え、設計に落とし込んでくれる Spec モードが特徴的な Agentic IDEです。

Spec モードを使うことで、小さな要件から徐々に機能を増やしていき、設計を細かくチェックしながら相棒として動いてくれます。

Kiroの基本的な使い方の説明などはAWS公式のブログで紹介されていますのでご覧ください。

この記事では、Kiroを日本語で便利に使う方法について触れていきます。

デフォルトだと出力される言語はどのようになる?

設定は一切変更せずに、SpecモードのKiroに対して日本語のプロンプトを入力したところ、以下の画像のような結果が返ってきました。

デフォルト設定&プロンプトを日本語で入力

プロンプトへの返信、そして requirements.md(リクエストを理解し、要求仕様を記録するファイル)に記載された要求仕様のいずれも日本語になっています。

このまま設計フェーズに進めてみましょう。

デフォルト設定&設計フェーズ

先ほどと同様に設計フェーズもプロンプトへの返信は日本語です。しかし、下記の画像を確認すると design.md(requirements.mdの内容から実装設計を記録するファイル)に記載された設計情報は一部英語が使われています。

一部英語が使われているdesign.md

さらに実装フェーズのタスクリスト作成へ進みます。

デフォルト設計&実装フェーズタスクリスト作成

プロンプトへの返信、 tasks.md(requirements.md、design.mdの内容から実装タスクの計画が記載されたファイル)に記載されたタスク一覧のいずれも日本語が使われています。

さいごに実装フェーズのタスクを実行します。

タスクを実行を指示すると自動的に新しいタブでVibe リクエストが処理されます。

デフォルト設定&タスク実行

自動的に入力されるプロンプト、そして返信が全て英語になってしまいました。さらに作成されたREADMEなどのファイルも全て英語です。タスク実行までは、ほぼ日本語で順調に進んでいましたが、タスク実行からはこの方法では日本語にならないことがわかりました。

実行ログ、ドキュメント、コードコメントを全て日本語で出力するため、いくつかの方法を試してみます。

requirements.md 作成のタイミングで実行ログ、ドキュメント、コードコメントを全て日本語で出力するように指示する(失敗)

SpecモードのKiroに対して一番最初のリクエストとして、下記のプロンプトを送信してみます。

毎日日本時間 23:30 にAWS の最新情報 (https://aws.amazon.com/jp/new/) から、当日分のアップデート情報を取得し、どのようなアップデートがあったかSlackに通知するアプリケーションを作ってください。

アプリケーションはPythonで作られ、Lambdaで動作するプログラムにしてください。

Kiroの実行ログ、ドキュメント、コードコメントを全て日本語で出力してください。

そのままタスク実行まで進めて、結果を確認します。

requirements.md作成時に日本語を指示&タスク実行

READMEは日本語になっていますが、タスクの実行ログは英語のままでした。

requirements.md 作成のタイミングで実行ログ、ドキュメント、コードコメントを全て日本語で出力するように指示してもタスクの実行ログは日本語にできませんでした。これは、tasks.mdにタスクの実行ログについてに関する前提条件がないため、英語で出力されているものと考えられます。

tasks.mdにタスクの実行ログを日本語にすることを追記する(失敗)

tasks.md の1番目のタスクに「Kiroのタスク実行ログを日本語で出力する」、「ドキュメント、コードコメントは全て日本語にする」を追記してタスクを実行します。

  • [ ] 1. プロジェクト構造とコア設定の作成
    • Kiroのタスク実行ログを日本語で出力する
    • ドキュメント、コードコメントは全て日本語にする
    • Pythonプロジェクトのディレクトリ構造を作成
    • requirements.txtファイルに必要な依存関係を定義
    • 基本的な設定ファイルとログ設定を実装
    • 要件: 5.1, 5.2

tasks.mdに日本語でタスク実行ログを出力するように明記

タスクの実行ログが日本語になりました!コードコメントも日本語になり、問題なく動作しているように見えます。 このままタスク2も実行してみます。

タスク2の実行

タスク2の実行ログが英語で表示されてしまいました。何度か試してみたところ、日本語で表示される場合もあれば、英語になる場合もありました。明確な条件は把握できていませんが、下記のとおり、タスク2の一覧には日本語に関する指示が含まれていないため、ログの表示言語が安定しないのだと考えられます。

  • [-] 2. 環境変数管理とバリデーション機能の実装
    • 環境変数を読み込み、バリデーションを行うConfigクラスを実装
    • 必要な環境変数が不足している場合のエラーハンドリングを実装
    • 単体テストを作成してバリデーション機能を検証
    • 要件: 2.1, 2.2, 2.3

Kiroで実行ログ、ドキュメント、コードコメントを全て日本語で出力する方法

Kiroで実行ログ、ドキュメント、コードコメントを全て日本語で出力する方法として、最も安定しているのは Steering ファイルを使うことです。

Steeringファイルは、Kiroにプロジェクトに関する永続的な知識や前提条件を与えるための仕組みです。その都度プロンプトやタスクリストなどで指示するのではなく、「あらかじめ知っておいてほしい情報」をSteeringファイルにMarkdown形式で記載しておくことで、Kiroはそれを前提知識として認識し、リクエストを処理します。

Steeringファイルを利用することで下記のような情報を Kiro に与えることができます。

  • コーディング規約
  • テストカバレッジの要件
  • チームやプロジェクトで定めた開発基準
  • 組織のQMS(品質管理システム)で定義されたルール

Kiroで実行ログ、ドキュメント、コードコメントを全て日本語で出力するためには、Steeringファイルに下記の内容を記載します。

Steeringファイルで指示する

# 日本語出力設定
 
 ## 言語設定
 - すべてのタスク実行結果、コメント、説明を日本語で出力してください
 - コードコメントも日本語で記述してください
 - エラーメッセージやログメッセージも可能な限り日本語で記述してください
 
## 出力形式
 - 技術的な説明も日本語で行ってください
 - 変数名や関数名は英語のままで構いませんが、説明は日本語にしてください
 - ドキュメントやコメントは日本語で統一してください

あまり細かく指定せず、この程度の粒度で記載する方が処理が安定しています。

まとめ

Kiroで実行ログ、ドキュメント、コードコメントを全て日本語で出力する方法を紹介しました。

英語で出力される内容に対して日本語で入力しても、Kiroは問題なく理解して処理してくれます。ただし、自分が慣れている言語でやり取りした方が、処理内容を把握しやすく、実行前の確認が必要な場合でも戸惑うことが少なくなります。

このブログが Kiro を活用するどなたかの役に立てば幸いです。