Readme Structure
Introduction
Each OCA module includes documentation (contained in the Readme file) explaining what is the purpose of the module, how to use it, how to configure it, etc. (5W : What / Why / Where / When / Who).
This Readme file is generated from different other files named "Fragments".
-
The Readme file is generated in the format RST .
-
The fragments are in the format Markdown (since 2023 / V17)
You can find the list of fragments that can be used to generate the Readme here
Final Structure (README.rst)
Description
This section appears at the top of the Readme and it describes
what
are the features of the module.
Installation
This section is used to give very specific installation instructions, such as installing non-python dependencies.
Use Cases / Context
This section should explain why the module was created, which business need this module covers to allow end-users to evaluate the module's usefulness in their context.
Configure
This section explains how to configure the module before using it providing with the steps to setup the module to be able to use it.
Usage
This section should explain, step by step, how to use the module.
Known Issues / Roadmap
This section is used to list the possible future improvements to the module or known issues.
Credits
This section shows additional credits, other than authors, contributors, and maintainers.
Authors
This section is automatically generated from the "Author" field in the module's manifest and list the authors of the module.
Contributors
This section is dedicated to list the people who worked on the module (Funcional Consultants, Developers).