Document template catalog

Introduction

Objecteering Document Publisher is delivered as standard with a number of document templates.

Directly usable document templates

Template	When	Applies to	Purpose	Description
Analysis & Design	Analysis and design stages.	Packages	Overview of the project’s model.	Deep exploration into the static and dynamic structures of the model, based on packages.
Book	Always.	Documents, Artifacts	Assembly of documents or external files.	Enables the assembly of different documents in order to build a more complex document. Ex.: combine \"Requirements\" with \"Dictionary\".
Class Reference	Development, maintenance, implementation and design stages.	Packages	Reference list of all classes, interfaces, enumerations and data types.	Provides a list of all classes, interfaces, enumerations, data types and their description. Alphabetically sorted.
Deployment Reference	Project management, integration and deployment.	Packages	Reference list of all productions and external elements.	A catalog of all Artifacts. Detailed description of each Artifact, including its kind (i.e. stereotypes) and manifested elements.
Diagrams Notebook	Always.	Packages	Reference list of all diagrams.	Catalog of all diagrams by type, sorted alphabetically.
Process	Analysis stage.	Packages		Catalog of all processes presenting their detailed content.
Use Cases	Analysis, requirement analysis.	Packages	Documenting the use cases of a system.	Overview of all actors and use cases. For each use case, a detailed description of its content is added (notes and scenarios). N.B.: Interactions contained in use cases are described as scenarios. Interesting combination with the "Requirements" template provided by Scope Manager.

Document templates requiring the BPMN MDAC

Template	When	Applies to	Purpose	Description
BPMN	Business analysis.	Packages	Business process modeling	Overview and detailed content of all BPMN processes.

Document templates requiring the Scope Manager MDAC

Template	When	Applies to	Purpose	Description
Dictionary (Extended)	At the beginning of a project.	Dictionaries	Glossary of a model's domain.	Can be used as an independent glossary or embedded in another document. More detailed than the Simple Dictionary.
Dictionary (Simple)	At the beginning of a project.	Dictionaries	Glossary of a model's domain.	Can be used as an independent glossary or embedded in another document.
Goals	At the beginning of a project.	Goal containers	Goal analysis.	Documents goals.
Impact	Development, maintenance, design.	Packages	Impact analysis report.
Business Rules	At the beginning of a project.	Business rule containers	Business rule analysis.	Documents business rules.
Requirements	At the beginning of a project.	Requirement containers	Business rule analysis.	Documents requirements with their natures and properties. Don't forget to produce a document when packaging a requirement RAMC. Interesting combination with the "Use Cases" and "Traceability Matrix" templates.
Business Rules Properties	At the beginning of a project.	Business rule containers	Definition of properties attached to business rules.
Goal Properties	At the beginning of a project.	Goal containers	Definition of properties attached to goals.
Requirement Properties	At the beginning of a project.	Requirement containers	Definition of properties attached to requirements.
Traceability Matrix	Design, development, maintenance and implementation stages	Packages, goal containers, business rules, requirement containers		Analysis of the traceability links between model and scope elements.

Document templates requiring the SOA_Solution MDAC

Template	When	Applies to	Purpose	Description
SOA	Analysis and design stages.	Packages	Overview of SOA architecture.	Provides a summarized description of the "Business Semantic", "Business Organization", "Logical Architecture" and "Business Implementation" aspects of the architecture.