Introduction
A short one or two paragraphs describing the purpose of the program or menu. In case of menu, try to comment the its purpose but not the internals of each program. This should be detailed inside each program's help.
Parameters
This section should be present only for program's 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 parameters.
- text used as label a
required parameter
Detailed description for this parameter. - text used as label for an
optional parameter
Detailed description for this parameter. - text used as label for second
optional parameter
Detailed description for this parameter.
Description
Feel free to describe each detail of the program or menu. However, note that the help of the menu must provide general information about its purpose only.
Notes
Any other 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.