# Documentation Tool for Ansible Role

**URL:** <https://forum.ansible.com/t/documentation-tool-for-ansible-role/26580>\
**Category:** Ansible Project\
**Created:** [January 29, 2018, 3:17am UTC](https://forum.ansible.com/t/documentation-tool-for-ansible-role/26580 "2018-01-29T03:17:17Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Mohit\_Dhingra](https://avatars.discourse-cdn.com/v4/letter/m/c67d28/32.png) [@Mohit\_Dhingra](https://forum.ansible.com/u/Mohit_Dhingra)\
**Post date:** [January 29, 2018, 3:17am UTC](https://forum.ansible.com/t/documentation-tool-for-ansible-role/26580/1 "2018-01-29T03:17:17Z")

</div>

Hi Ansible Users, Is there any documentation tool for available for Ansible role. I have created a role and i want to document it.

---

<div class="post-metadata">

**Author:** ![Andrew\_Latham](https://avatars.discourse-cdn.com/v4/letter/a/ed8c4c/32.png) [@Andrew\_Latham](https://forum.ansible.com/u/Andrew_Latham)\
**Post date:** [January 29, 2018, 4:06pm UTC](https://forum.ansible.com/t/documentation-tool-for-ansible-role/26580/2 "2018-01-29T16:06:38Z")

</div>

Industry standard would be to start with a README

[https://en.wikipedia.org/wiki/README](https://en.wikipedia.org/wiki/README)

---

<div class="post-metadata">

**Author:** ![Kai\_Stian\_Olstad](https://avatars.discourse-cdn.com/v4/letter/k/e19adc/32.png) [@Kai\_Stian\_Olstad](https://forum.ansible.com/u/Kai_Stian_Olstad)\
**Post date:** [January 29, 2018, 4:44pm UTC](https://forum.ansible.com/t/documentation-tool-for-ansible-role/26580/3 "2018-01-29T16:44:05Z")

</div>

There is some discussion here  
[https://github.com/ansible/proposals/issues/19](https://github.com/ansible/proposals/issues/19)