Document Analysis

The Document Analysis pattern creates an Artifact element that is used as a surrogate for a file or web page located outside the Enterprise Architect repository. The external file can simply be dragged onto the diagram and a link will be created.  Issues have been added describing the document analysis and these can be viewed using the Element Browser or the Issues window. Document analysis can be performed on any number of documents and is useful to determine context, business rules and requirements.

Figure 1. Shows the Element Browser where the file location is defined and a number of Change Management Issues have been defined.
Discussion
The purpose of the pattern is to provide a formal way of working with external documents and recording the findings of the analysis. It allows external documents and web pages to be referenced inside Enterprise Architect and related to other elements and information contained in the repository.
The pattern can be used at any point during an initiative when new documents or information comes to light but it is particularly useful in the early stages of an initiative when much of the work on an initiative is typically recorded in text based documents or web pages. It is particularly useful when there are no subject matter experts available and the only information that can be found exists in documents such as User Manuals or Specifications. It can also be used by technologist when reviewing detailed component or device specifications.

The following is a list of some things you may want to do when working with this pattern.
·	Create a diagram and drag external document onto the diagram.
Create an Artifact and add a link (file or URL based) to the external document.
Add Maintenance Items to the Artifact to record the findings of analysis.
The external file or web page can be viewed by using the <CTRL> <E> keys or <F12>.

The following is a list of some of the next steps available when applying the pattern.
·	Define Trace relationships showing how the documents relate to up-process elements such as Strategies, Business Rules and Requirements and down-process elements such as User Stories, Use Cases, Components, Artifacts and database tables.
Create high quality documentation generated automatically from the model.
Create Discussions and Reviews and engage in Chat to collaborate with team members, Requirement owners, Product Managers and other stakeholders.
Reference
The following help topics will assist you learn about how to work with this pattern.
Document Analysis
Linked Documents
Artifact
Maintenance Items
Business Analysis Body of Knowledge (BABOK)
Traceability Tools
Documentation

The following are some of the tools that will be helpful when working with this pattern.
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.
Artifact
An Artifact can be used as a placeholder for a Financial Analysis file or web address such as a spreadsheet or document that resides external to the repository. The Artifact element can be hyper-linked to the external document allowing it to be launched from within Enterprise Architect. This provides a convenient way to reference the document inside the model for example by linking other elements such as Requirements to the document. For more details see the Artifact 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.
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 or the more general topic on Model Publishing.
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.
Specification View
The Specification View can be used as a way of working with any element type in a spreadsheet or word process view. It is particularly useful when there are a large number of elements as is typically the case when describing a system of any appreciable size. For more details see the Specification View help topic.
Relationship Matrix
The Relationship Matrix provides a spreadsheet like view of two groups of elements and the relationships that exist between them. It can be a used as a powerful analysis mechanism to visually indicate how elements are related to each other and to discover which elements are missing relationships. For more details see the Relationship Matrix  help topic.
Traceability Window
The Traceability Window automatically displays the relationships that exist between Use Cases and other model elements including up-process and down-process elements. The traceability tree view can be conveniently expanded to see deeper relationships and elements displayed in the window can be located in all diagrams in which they appear. For more details see the Traceability Window  help topic.

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