Introduction to Documentation
Documentation Tools
In HOPEX, you can access different documentation tools providing a response to internal and external communication needs. Documentation is an essential task in the context of a modeling approach. A modeling approach does not only consist in the display of models, no matter how complete and accurate the latter may be.
These tools can be classified according to the type of document provided:
• tools enabling to generate documentation from the repository data:
• reports
• instant reports
• reports MS Word
See Generated Documents.These features do not require any specific option.• tools enabling to store, in HOPEX, documents with a content unrelated to the repository:
• external references
• business documents
Generated Documents
From the repository objects, HOPEX enables to generate the following document types:
• reports to study interactions between repository objects
See Generating Reports.• instant reports, to get a statistical, graphic analysis of the data related to the analyzed objects
• reports MS Word
In HOPEX, specific elements are available to help you generate documentation:
• the Report DataSet from which you can create instant reports
A Report DataSet is an extraction of a set of repository data, displayed in a tabular form.• the GraphSet from which you can create graph-type reports
A GraphSet is an extraction of a set of repository data, displayed in graph form (set of nodes and arcs grouped according to one or several analysis criteria).• the TreeSet from which you can create tree-type reports (Dendrogram, Breakdown map, TreeTable)
A TreeSet is an extraction of a set of repository data, displayed in a tree form (root node and its descendants).You can customize your reports.
See Managing Reports.