Major Document the content of the repository: inventories, roles, plays, main tasks, tags...
Explain the hierarchy in the README.
. ├── ansible.cfg ├── callback_plugins │ └── fix-ssl.py ├── docker │ ├── Dockerfile │ └── files ├── inventory │ ├── docker │ ├── production │ ├── slave-common │ ├── slave-preprod │ ├── slave-priv │ ├── slave-pub │ ├── stage │ └── winslave ├── README.md ├── README.winslave ├── roles │ ├── slave_cache │ ├── slave_config_common │ ├── slave_config_qa │ ├── slave_config_qapreprod │ ├── slave_config_qapriv │ ├── slave_env_cleanup │ ├── slave_tools │ ├── winslave │ └── winslave_cache ├── slave-common.yml ├── slave-preprod.yml ├── slave-priv.yml ├── slave-pub.yml └── winslave.yml
Are those simple rules enough for doc? https://github.com/geerlingguy/ansible-for-devops/issues/47#issuecomment-269425185
See http://docs.ansible.com/ansible/dev_guide/developing_modules_documenting.html
Look for http://docs.ansible.com/ansible/playbooks_best_practices.html
