This appendix provides a template section structure for a process. Things to include:
Each section shall contain a unique id tag. Id tag names contain are an aggregate of the section name and predecessor section ids.
Example A.1. Naming section id tags
<section id="someprocess">
<title>Some Process</title>
...
<section id="someprocess_sometool">
<title>Some Tool</title>
...
Note1: Ids are all lower case. This is because tags can be converted into filenames and some versions of windows have problems distinguishing between cases.
Note2: There is an underscore between section names, and no underscore describing a section.
Note3: The section id should be an abbreviation of, or the same as the section title.
Note4: Only sections require id attributes.
Be concise and reference external documentation in preference to rewriting or copying the documentation into generguide. Owners of a tool or process are more likely to keep documentation updated than you are, and concise documentation is more likely to be read.
The first sentence or two should describe what the process does. You might want to reference an in depth description on the web somewhere. The following sections can be presented in any order.
The first sentence or two should describe the tool which handles the process.
Remaining paragraphs and sub-sections should describe how to configure and use the tool.
Some processes require multiple tools, for other processes you may have multiple tools to choose from.