Software development is a process in which the reviews of the status of work are a daily or almost everyday situation. Verification of analytical and design works as well as architectural works is not only a question of what has been done, but also questions: how has it been done? How will it work?
In these manufacturing processes, in which the specification is prepared in the form of models, diagrams and other artifacts, the review of works is a review of diagrams. Models such a review may be performed by a representative of the business, a member of the team or in the case of documentation provided by an external supplier – the representative of the ordering.
The classic approach is to prepare a report and generating a report. Collecting comments on models and descriptions in Word, Excel and subsequent discussions introducing changes to Enterprise Architect. It is an intensive process. The documentation review in Enterprise Architect is a feature that is not very often used and which allows you to discuss and carry out the model review process directly on the models.
The Review element is a simple mechanism that enables real-time discussions that can relate to one or several elements and/or diagrams. Typically, a project manager, team manager, or other person in the project creates a review element to discuss one or more objects at a given stage of the project.
The simplest version of the model overview in Enterprise Architect is that the Reviewer (any of mentioned person from the team) creates the Review element. It is the best to create such element on the review diagram – Diagram Review
After the added element, a diagram is created where you can move the reviewed items. In this way, we indicate the scope of the review. It is also worth adding a checklist element to show what parameters will be checked. The lists are useful for verification of methodical elements such as – whether the required fields in the element have been described, whether appropriate mappings have been made between the elements, etc.
You can add a discussion topic to each element, and have a discussion about your mind. Classically, it is indicated here that the attention was realized.
An important element is the history of the review
When writing about the ongoing discussions, one cannot fail to mention that at any time, without starting the review, discussion can be started. What’s more, this discussion, or rather its result, can be directed to acceptance.
Is the model overview in Enterprise Architect a good idea?
In my opinion, yes. Admittedly, this feature has some minor shortcomings, but it makes the review easier in a radical way. What’s more, with every version of Enterprise Architect, this feature is being improved.
Is browsing models in Enterprise Architect common?
In my opinion, this function was not and not very often used, because it required all people to have access to Enterprise Architect. Models and their descriptions should be reviewed primarily by business representatives. Expecting business representatives to use Enterprise Architect in most companies is for many reasons an absurd idea. Today, solutions such as Sparx Systems Pro Cloud Server or Prolaborate enable verification and commenting of models via a web browser. In other words, they do not require the reviewing model to have access to Enterprise Architect.
To sum up, an overview of models in Enterprise Architect means not only saving time, but also the opportunity to discuss the solution directly under the discussed artifact. The use of the review mechanism allows you to review models and thereby document the design decisions are taken.