...
Required section. Use this section to describe the context surrounding when this step or job entry is used. It is also possible to link to another page which has workflows and tasks.
The context might include . . .should include information about when and why you would use this step or entry, as well as additional information to help the user understand the benefits of the step or entry in a typical workflow.
Prerequisites
Optional section. Use when prerequisites need to be met and/or checked.
...
TBD: 1) Omit not needed information: e.g. step name (should be describes not within each step/job entry but at the beginning) 2) Should we omit other obvious properties? 3) Should we omit the recurring information in field tables like: field name, type, length, precision etc. ?)
Use It is recommended that a screenshot before of the tab is included above the table for each tab.
Option | Description |
|---|---|
Option1 Option 1 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam. |
Option2 Option 2 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam
|
Sample 1 Tab
Use It is recommended that a screenshot of each the tab before is included above the table.
Option | Description |
|---|---|
Lorem ipsum option1 Option 1 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam. Lorem ipsum option2 |
Option 2 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam |
Sample 2 Tab
Use It is recommended that a screenshot of each the tab before is included above the table.
Option | Description |
|---|---|
Lorem ipsum option1 Option 1 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam. Lorem ipsum option2 |
Option 2 | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam |
...
Optional section. Use this section to list internal or external links, such as step-by-step and workflow topics, related to this step/entry topic.
"For workflow and use case information, see Lorem ipsum: http://en.wikipedia.org/wiki/Lorem_ipsum."
Technical Information
Optional section. Use this section when to provide technical documentation to developers. For example, you can include a link to the source code, special topics for developers, or links to the source code or Javadoc.
"Source code for Lorem ipsum can be found here: http://en.wikipedia.org/wiki/Lorem_ipsum."