Prompt file imported from ks6088ts/template-terraform (
.github/prompts/update-readme.prompt.md). Fill in{{updateType}},{{scenarioName}},{{additionalInfo}}before use. Copyright stays with the author.
README 更新
シナリオ追加や変更に伴う README の更新を行います。
入力情報
更新タイプ: {{updateType}} シナリオ名: {{scenarioName}} 追加情報: {{additionalInfo}}
実行内容
更新タイプに応じて以下を実行してください:
scenario-table の場合
README.md のシナリオテーブルに {{scenarioName}} を追記してください。
概要: {{additionalInfo}}
architecture の場合
{{scenarioName}} シナリオのアーキテクチャ図を README.md に追記してください。
図表はすべて Mermaid フォーマットを利用してください。
procedure の場合
{{additionalInfo}} を実行する手順を README.md に追記してください。
shell コマンドで簡単に実行できる方法を記載してください。
README フォーマット規則
- 図表は Mermaid 形式で記載する
- シナリオはプロバイダ(Azure, AWS, Google, GitHub, その他)ごとにテーブルで整理
- シナリオテーブルには以下の列を含める:
- Scenario: シナリオへのリンク
- Overview: 簡潔な説明
注意事項
- 技術者以外でもわかる平易な説明を心がける
- 冗長な一般的説明は避ける
- 具体的な操作手順はコマンド例を添える
参照ファイル
README.md- 更新対象のファイルinfra/scenarios/- 既存シナリオの実装例