|
|
|
|
A How Do I: topic should include little more than procedures for a specific task and links to topics that inlcude more information about when and why you would perform the task. This is not the venue for conceptual background. In some cases, instructions take a narrative form, but more often than not they will belong in bulleted or numbered lists.
You can include as many tasks as relate to the subject, although this is unlikely to exceed 2 or 3.
A How Do I topic, however, should include more than just links. If the only things to know about how to do something are documented in other topics, strongly reconsider writing a How Do I: topic to explain this.
If the topic includes descriptive sections as well as strait procedures, introduce them with h2 headings and normal heading terminology (that is, begin with a verb, rather than with "To..."). Do not repeat conceptual information found in another topic. Instead, include the relevant procedure and a link to the other topic.
To Do Something |proch1|
Do not emulate this template and include text before the procedure. Jump right into the procedure. With very few exceptions, all introductory information should appear in the introductory section.
Related Topics |relatedtopics|
How Do I: Use an Apache SOAP Web Service?
How Do I: Start or Stop WebLogic Server?
 |