Objecteering Documentation User Guide

Table of Contents

 

 

Chapter 1 – Introduction to Objecteering documentation

              Overview of Objecteering documentation

              Customizing documentation generation

              Glossary

             

    

Chapter 2 – Quick tour

              Overview of this quick tour

              Creating notes and tagged values

              Creating document links

              Launching documentation generation

              Partial documentation generation

 

 

Chapter 3 – General principles

              Notes

              Tagged values

              Model structure

              Document template

              Formatters

              Consistency management

              Diagrams

              Model explorer generation

              Index generation

             

 

Chapter 4 – Generating documentation

              Defining documentation properties

              Configuring documentation generation

              Partial documentation generation

             

 

Chapter 5 – The analysis document template

              Overview of the analysis document template

              The Overview chapter

              The Preliminary specification chapter

              The Definition of the use cases chapter

              The Detailed specification chapter

              The Use cases chapter

              The Examples chapter

              Description of a package

              Description of a class or an interface

              Description of a collaboration

              Description of a state machine

              Description of an activity graph

              Description of a use case

              Description of an actor

              Description of an operation

              Description of an instance

              Partial documentation generation

             

 

Chapter 6 – The design document template

              Overview of the design document template

              The Overview chapter

              The Architecture chapter

              The General design chapter

              The Traceability chapter

              The Integration chapter

              Description of a package

              Description of a class or an interface

              Description of a collaboration

              Description of a state machine

              Description of an activity graph

              Description of a use case

              Description of an actor

              Description of a component

              Description of a node

              Description of an operation

              Description of an instance

              Other described elements

              Partial documentation generation

             

 

Chapter 7 – Customizing documentation generation

              The TPF tool

              Presentation markers

              Chapters

              Images

              Messages

              Escape markers

              Style definition markers

              Text insertion markers

              Creating new markers

              Working with the styles dot document model

              Removing items from the cover page of a document

              Modifying headers and footers

Automatically generating a document defined in an Objecteering database

 

 

Chapter 8 - Advanced document template customization

Overview of advanced document template customization

              Document work product

              Creating rules

              Customizing HTML generation

              Generating tables

              Scrolling through the metamodel

              Methods for scrolling through the metamodel