Vision and Scope Document

The Vision and Scope Document pattern creates a package, elements and a diagram that model the structure of a Vision and Scope document. Elements from the repository can be dragged-and-dropped into the model document packages creating a virtual document that can be used to dynamically generate the master document from repository content.

Figure 1. Shows a Documentation diagram that contains a Master Document that can be used to generate the Vision and Scope Document from content within the repository.

Figure 1.

Discussion
The purpose of the pattern is to allow Business Architects, Business Analysts and other stakeholders to generate a Vision and Scope document directly from content in  the repository.  It also provides a flexible template facility that allows each section of the document to be styled differently while at the same time maintaining master styles and numbering across the entire document.

The patten is typically used when some content has been added into the repository but it can also be setup early in an initiative and used to generate progressively finished versions of the Vision and Scope document. The pattern works irrespective of modeling language o process.

The following is a list of some things you may want to do when working with this pattern.
·	Change the name and notes of the Master Document Package to suit the initiative.
Change the name and notes of the Model Document elements to suit the Initiative.
Change the Order of the Model Document elements in the Project Browser to change the order of each section.
Drag-and-drop packages from the Project Browser onto  the appropriate  Model Document to add content to be generated for that section of the Master Document.
Assign new or use existing document templates to the RTFTemplate tag in the Tagged Values window.

The following is a list of some of the next steps available when applying the pattern.
·	Create additional Model Documents as required.
Create a document cover page with an organization logo and other details.

Useful Workspace Layouts Core | Core Modeling, Wide View
Reference
The following help topics will assist you learn about how to work with this pattern.
Model Publishing
Virtual Documents
Document Templates

The following are some of the tools that will be helpful when working with this pattern.
Document Generator
The Document Generator is a powerful facility in Enterprise Architect that allows a Database Engineer or other stakeholder to create high quality corporate or technical documentation directly from the model, suitable for internal or external audiences. For more details see the Documentation help topic.
Baseline Tool
The Baseline Tool can capture a snapshot of a selected Package at a point in time and then at a later time the repository can be compared to this (or another baseline) for the purpose of determining what has changed. Any number of baselines can be created and labeled and there is a baseline comparison tool which displays the differences between the baseline and the model and allows the modeler to revert a change in the model to a baseline at a granular level. For more details see the Baseline Tool help topic.
Linked Documents
Linked Documents provide a way of incorporating extensive and highly formatted documentation for an element. While an elements notes are a useful place to provide brief and visible information about an element a Linked Document can be used to create extensive documentation for an element including all the features you available in a typical word processing tool such as: Paragraph Formatting, Header and Footers, Table Images, Tables of contents and much more. For more details see the Linked Documents help topic.
Document Window
The Document Window is a powerful tool for generating, reading and editing narrative style information for an element. There are two tabs: the Dynamic Document Tab and the Linked Document Tab. The Dynamic Document tab generates documentation automatically from element information and the Linked Document tab cab be used for reading and editing an element's linked document. For more details see the Document Window help topic.
Element Discussions
The Element Discussion facility is a fully featured collaboration tool allowing modelers and model viewers and reviewers to communicate with each other directly inside the repository. Modelers using the full client or occasional viewers using WebEA can both post and reply to discussions and communicate and engage in chat. For more details see the Element Discussions help topic.
Diagram Layout
The Diagram Layout tool allows you to layout an entire diagram, selected elements or sections of a diagram to make it more visually appealing or meaningful to a particular audience. There are a wide range of layout types to choose from and some types have filters that can be applied. For more details see the Diagram Layout help topic.

© 2000 - 2018  Sparx Systems Pty Ltd.  All rights Reserved.