This procedure describes how to...
|
|
|
|
|
|
|
|
|
<Are there any prerequisites?>
|
|
|
|
|
Example: |
|
<Postreq> |
|
|
|
|
|
|
Related Links: |
|
|
|
Concept topics answer ″What is...″ questions. They include a body-level element with a basic topic structure, including sections and examples.
Concepts provide background that helps readers understand essential information about a product, interface, or task. Often, a concept is an extended definition of a major abstraction such as a process or function. Conceptual information may explain a product and how it fits into its category of products.
Conceptual information helps users to map their existing knowledge to tasks and other essential information about a product or system.
It can contain paragraphs, lists, and other elements as well as sections and examples.
Always link your concepts to a task/s.
THE LAYOUT IS REGULAR PARAGRAPHS.
Always start with contents after a short introduction and include links to the top in long topics:
|
|
|
|
|
|
|
|
|
|
|
|
Always add related links to the end of the topic
|
|
Related Links: |
<title>
<short description>
Always start with contents after a short introduction and include links to the top in long topics:
|
|
|
|
|
|
|
|
|
|
|
|
<List or table>
List - use styles List 1 list 2 and list three - do not exceed three levels
Table:
|
titles are bold |
|
|
|
content is table text |
|
|
|
|
|
|
or
|
titles are bold |
content is table text |
|
|
|
|
|
|
|
|
|
Always add related links to the end of the topic
|
|
Related Links: |