Introduction
A short one or two paragraphs describing the purpose of the program or flow. In case of flow, try to comment the flow purpose but not the internals of each program. This should be detailed inside each program's help.
Required parameters
This section should be present only for program helps. You should describe each parameter the user must specify to properly configure the program. It can be suppressed in case the program has not required parameters.
- [text used as label for first parameter] detailed description for this parameter.
- [text used as label for second parameter] detailed description for this parameter.
Optional parameters
This section should be present only for program helps. You should describe each parameter the user may specify to properly configure the program. It can be suppressed in case the program has not optional parameters.
- [label for parameter] detailed description.
Description
Feel free to describe each detail of the program or flow.
Notes
Any first comment or detailed information might be given here.
References
A list of references where the algorithm or strategy is published and/or described.
- Ö Yilmaz. Seismic Data Analysis: Processing, Inversion, and Interpretation of Seismic Data. Society of Exploration Geophysicists, Tulsa, second edition, 2003.
- Robert E. Sheriff. Encyclopedic Dictionary of Exploration Geophysics, volume 13 of Geophysical References Series. Society of Exploration Geophysicists, Tulsa, 4th edition, 2002.
Credits
In case of a program, credit each developer of the program. In case of a flow credit the author of the flow.