Introduction to Documentation
Documentation Tools
HOPEX offers several documentation tools that supplement description of models supplied as standard, providing a response to internal and external communication needs. Documentation is an essential task in modeling. A modeling approach does not simply consist of the presentation of schemas, however complete and accurate these may be.
These tools can be sorted according to the type of document provided:
• tools that generate documentation from repository data:
• reports (MS Word)
• analysis reports
• Instant reports
• Web sites
The features covered here are available as standard, irrespective of options.• tools that store in HOPEX documents of which content is independent of the repository:
• external references
• business documents
Documents Generated From the Repository
HOPEX enables generation of several types of document from repository objects:
• reports (MS Word)
• analysis reports to study interactions between different repository objects
• instant reports offering a statistical graphic analysis of the data of analyzed objects
• web sites to generate a set of HTML pages that can be published on an Intranet
HOPEX enables generation of several types of document from repository objects:
• the Report DataSet from which you can create instant reports
A Report DataSet is an extraction of a set of repository data, displayed in tabular form.• the GraphSet from which you can create reports with graph type renderings
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 reports with tree type renderings (Dendrogram, Breakdown map, TreeTable)
A TreeSet is an extraction of a set of repository data, displayed in tree form (root node and its descendants).You can customize your reports.