This document describes the ways in which we create and maintain the tasks document also known as the Tasks Cookbook. The Cookbook is be accessed from the Config Tool and Monitor Tool through the Docs button. The Cookbook is created with FrameMaker and then converted to HTML with WebWorks Publisher.
|
Document Organization |
The document itself consists of a table of contents; a series of sections, each dealing with a single subject (multicast tunnels, IPX, etc.); and an index. Each section can contain as many tasks related to the given subject as are necessary. The organization is as follows:
Grouping the tasks by subject allows us to complete a section at a time and add it to the Cookbook as we complete it. This enables us to produce a document (such as a beta release) even though we may not have the entire Cookbook completed or the indexing done.
Each section can contain the following:
The FrameMaker document for a section starts with a line tagged ChapTitle. This tells the user the subject of the section, for example, Multicast Tunnel.
The tags that can be used include:
Body
Body2
Body3
Caution: This is a caution. It points out ways to avoid damaging your
hardware or data.
Warning: This is a warning. It states potential dangers to your
personal safety if the procedure is not followed.
Note: This is a note. It provides information that is related to the text
Tip: It points out ways you can improve the efficiency of your network
procedures.
CellHeading |
---|
CellBody |
Code
Code2
Code3
CodeWide
1. Task_Step_One
2. Task_Step
Task_Body
|
This is a Task Header |
http://<switchname>/conf/Task_Desc.fm.html