Tool Manual
- Tool Manual
- a convention that describes a
tool and how to use it
As illustrated in the preceding figure, tool manuals are part of the following inheritance hierarchy:
- Type: Concrete
- Superclass: Convention
- Subclasses: None
- Example Instances:
- User manuals for requirements management tools
- User manuals for modeling tools
The typical responsibilities of a tool manual are to:
- Describe the associated tool including its objectives and features.
- Describe how to effectively use the tool.
- Tool manuals may be either paper or electronic.
- Tool manuals may be built into the tool (e.g., in the
form of help features).
- The more user friendly the tool, the less need for a
separate tool manual.
- Tool manuals may overlap with training materials about
the tool.
