EA and eaDocX Sample Document

EA and eaDocX Sample Document
This sample document shows how EA and eaDocX can produce high-quality, readable documents directly from
an Enterprise Architect model. All information in this document is taken from the EA Example model, and is
©Sparx Systems.
Comment [I1]: The document headings
are taken – by default – from the package
structure in EA. So the top-level package
creates a Heading1, and its child packages
Heading 2’s etc
New Quotes and Ordering Process
These are the details for the proposed new Quotes and Ordering process.
Business Process Sub Process Activ ity
Order Handling
no
Quotation
Handling
Approve Order
Review Order
yes
Approved?
Shipping Handling
Double click this Activity
element to go down to
sub-level.
Figure 1 : Sub Process Activity
Comment [I2]: You decide which
diagrams to include. eaDocX automatically
adds figure numbers
1.1 Quotation Handling
Takes the Quote, as entered by the customer, does some simple checks, then logs it in the system.
Ref
3.2.1
Task Type
Requires Use Cases
New Requirements
Abstract
Create Quote
Quotation rate card
Comment [I4]: These are a few
interesting attributes of the Activity, plus
some related data: the Use Cases to which
the Activity is linked, and the
Requirements.
Issues with this Activity
Issue Ref
Issue description
Priority
ISS056
Name of the Activity doesn’t conform to our naming standards.
Should be ‘Handle Quote’, or ‘Process Quote’.
Medium
Comment [I3]: In this example, each
Activity has been given a separate heading.
We might also have chosen to make each
one a row in a table of Activities.
Owner
Comment [I5]: We’ve added some
Conditional Formatting to this field. The
rule we used was ‘if the ‘Owner’ is blank,
print it in red’. This will help us to spot
where we have issues with no owner.
1.2 Approve Order
Checks that the new order does not exceed local maximum value threshold.
Ref
3.2.2
Task Type
Requires Use Cases
New Requirements
None
Approve Order
Order auto-completion
1.3 Order Handling
Ref
3.2.3
Task Type
Requires Use Cases
New Requirements
None
Modify order,
Dispatch order,
View order
Dispatch priorities,
Enhanced security
Comment [I6]: The other Activities are
also printed as Heading 2s
Comment [I7]: The requirements are
printed as hyperlinks, which link to the list
of Requirements later in the document.
This lets users browse around the
document to find what they are interested
in.
Issues with this Activity
Issue Ref
Issue description
Priority
Owner
ISS057
Name of the Activity doesn’t conform to our naming standards.
Should be ‘Handle Order’, or ‘Process Order’.
Medium
Bill
© Ability Engineering Ltd. 2012
1.4 Shipping Handling
Ref
3.2.4
Task Type
Requires Use Cases
New Requirements
Task Type
Requires Use Cases
New Requirements
User
View order
None
1.5 Review Order
Ref
3.2.5
1.6 New Requirements
These are the new system requirements which have emerged from the design of these new processes.
Ref
Requirement
Details
OP-RQ-0340
Dispatch priorities
The solution shall support resetting of dispatch priorities
OP-RQ-0127
Enhanced security
The solution shall support up to 9 security levels
OP-RQ-0034
Order auto-completion
The solution shall allow for auto-completion of new orders.
Q-RQ-4725
Quotation rate card
The Quotes System shall support the modified rate card
Comment [I8]: These are all the new
requirements which we had previously
referenced.
1.7 Supporting Systems
These are details of the existing systems which have use cases which are used by the new process.
Ordering System Use Cases
Supporting Use Case
Ref
Used by Activities
Approve Order
OP-UC-012
Approve Order
Dispatch order
OP-UC-134
Order Handling
Modify order
OP-UC-135
Order Handling
OP-UC-139
Order Handling,
Review Order
View order
For more information about
eaDocX, and to download a free,
fully-functional 30-day evaluation
copy, see www.eadocx.com.
© Ability Engineering Ltd. 2012
Comment [I9]: And these are the Use
Cases which were connected to Activities.
If we found a Use Case which wasn’t used
by any Activity, that might mean we have a
missing Activity.
For more information about Ability
Engineering training and mentoring
services, see
www.abilityengineering.co.uk