红帽全球峰会8.6. 为您的角色集合添加文档
为您的角色提供文档非常重要，以便其他用户了解您的角色的作用以及如何使用它们。
8.6.1. 记录您的角色
复制链接链接已复制到粘贴板!
当您构建集合目录时，在角色目录中添加了一个 README.md 文件。在此文件中为角色添加您的文档。在 README.md 文件中为集合中的每个角色提供以下信息：
- 角色描述：角色的作用的简要概述
- 要求：列出集合、库和所需安装
- 依赖项
角色变量：提供有关角色使用的变量的以下信息。
- 描述
- 默认值
- 示例值
- 所需的变量
- 示例 playbook：显示使用您的角色的 playbook 示例。使用 playbook 中的注释来帮助用户了解在哪里设置变量。
controller_configuration.ad_hoc_command_cancel 中的 README.md 文件是一个带有标准文档的角色示例：
8.6.2. 记录您的集合
复制链接链接已复制到粘贴板!
在集合的 README.md 文件中，提供以下信息：
- 集合描述 ：描述集合的作用。
- 要求：列出所需的集合。
- 将角色列为集合的一个组件。
- 使用集合： 描述如何运行集合的组件。
- 添加故障排除部分。
- 版本：描述集合的发行周期。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}