8.6. ロールコレクションのドキュメントを追加する

他のユーザーがロールの機能とその使用方法を理解できるように、ロールに関するドキュメントを提供することが重要です。

コレクションディレクトリーをスキャフォールディングすると、ロールディレクトリーに README.md ファイルが追加されます。このファイルに、ロールに関するドキュメントを追加します。コレクション内の各ロールの README.md ファイルに、次の情報を記載します。

ロールの説明: ロールの機能の簡単な概要
要件: コレクション、ライブラリー、および必要なインストールのリスト
依存関係
ロール変数: ロールが使用する変数に関する次の情報を記載します。
- 説明
- デフォルト
- 値の例
- 必須の変数
Playbook の例: ロールを使用する Playbook の例を示します。Playbook 内のコメントを使用して、ユーザーが変数を設定する箇所がわかるようにします。

controller_configuration.ad_hoc_command_cancel の README.md ファイルは、標準ドキュメントを含むロールの例です。

コレクションの README.md ファイルに次の情報を記載します。