Amazon Q Developer を使用したドキュメントの生成

新しいドキュメントの作成 – Amazon Q は、選択したフォルダのコードに基づいてプロジェクトの新しい READMEs を作成できます。既に README があり、新しい README を作成することを選択した場合、Amazon Q は既存の README を上書きし、更新しません。Amazon Q が元の README を上書きする前に、新しいコンテンツを確認するオプションがあります。

図の作成 – プロジェクトフォルダに infrastructure-as-code ファイル ( AWS CDK ファイル AWS CloudFormation 、テンプレート、Terraform 設定ファイルなど) が含まれている場合、Amazon Q はdocsフォルダ内のinfra.svgファイルに出力され、README で参照されるインフラストラクチャ図を作成します。を使用している場合はVisual Studio Code、IDE 内の図を表示するために SVG プレビュー (または同様の) 拡張機能をインストールする必要がある場合があります。

特定の更新を行う – Amazon Q が README に加える変更を自然言語で記述できます。これを行うには、既存の README を更新し、特定の変更を行うオプションを選択します。Amazon Q がドキュメントを生成したら、追加の変更を記述するオプションがあります。セクションの追加、既存のセクションの削除、既存のセクションの詳細化などの更新をリクエストできます。

新しいコードを確認し、ドキュメントの更新を提案する – コードを変更した後、Amazon Q は新しいコードを確認し、関連する更新を README に提案できます。

.template ファイル

requirements.txt

package.json

tsconfig.json

Dockerfile

.git/config

LICENSE

LICENSE.md

貢献

CONTRIBUTING.md

README サイズ – Amazon Q が確認または生成できる README の最大サイズ。既存の README がこのクォータを超えると、Amazon Q は既存のドキュメントを更新できません。生成された README がこのクォータを超えると、Amazon Q は更新された README を返すことができません。

コードプロジェクトサイズ – Amazon Q がドキュメントの生成に使用できるプロジェクトまたはワークスペースの最大サイズ。

ドキュメントを生成する小さなフォルダを選択した場合でも、親プロジェクトまたはワークスペースはこのクォータ内にある必要があります。

タスクあたりのドキュメント生成 – 最初のドキュメント生成など、生成されたドキュメントに変更を加えるためにフィードバックを提供できる回数。このクォータは、新しいドキュメントタスクを開始するたびにリセットされます。