RG-DOC-002 Argument Annotation

Description

RG-DOC-002 ensures that each Argument of a workflow is annotated.

Impact

Without having adequate documentation, resources have to read and comprehend a workflow’s implementation to ascertain the purpose of each workflow argument.

Mitigation

Add an Annotation to each workflow argument to document its purpose and usage conditions.

• Ensure documentation is clear and concise.
• Consider utilising simple markdown syntax to format comments.

Further Reading

—