Book a Demo

Author Topic: Best Practices  (Read 4709 times)

CraigSmith

  • EA Novice
  • *
  • Posts: 1
  • Karma: +0/-0
    • View Profile
Best Practices
« on: March 11, 2004, 09:04:37 pm »
I'm wondering if there are any best practices documents out there on general use of EA.  I see a lot of documentation on specifics but I don't see many recommendation on how to organize the views, models and diagrams.  The example provides a little of that.  I've just started with the tool and an import of a jar left me with a lot of separate diagrams that are difficult to relate and navigate.

Craig

thomaskilian

  • Guest
Re: Best Practices
« Reply #1 on: March 12, 2004, 06:16:27 am »
Hi Craig,
you will not find a cookbook since the ways you can use UML (and EA to support ist) are not fixed. There is no kings path. There are some recent discussions where books are recommended on how to proceed (beware the 7-days limitation in the search window!). However, you have to find your path by yourself  :-/

Not much help, sorry for that.

Thomas

thomaskilian

  • Guest
Re: Best Practices
« Reply #2 on: March 12, 2004, 06:20:38 am »
P.S. obviously the forum will be reorganized in the near future (see recent topic). Likely you will be able to pick more valuable information then  :D

fluxtah

  • EA User
  • **
  • Posts: 144
  • Karma: +0/-0
    • View Profile
Re: Best Practices
« Reply #3 on: March 12, 2004, 02:43:15 pm »
Hiya,

I am currently learning how to use EA, the cool thing about it, which was one of thomas's points, that it is very flexible and allows you to just about make up any package structure to suit everybody's flavour of process.

Even though I am no expert, here are my thoughts:

By using the packages from the example model in Messenger/Model Views you could use these as your top level views, we have:

Business Context Model
Requirements Model
Analysis Model
Design Model
Component Model
Deployment Model
Environment Model

Now all these packages would support the disciplines involved in software development nicely although I use these views:

Business Model
Requirements Model
UX Model
Analysis Model
Design Model
Implementation Model
Test Model

Since I am learning and most of my books involve the above disciplines it seems a good way to order them.

Activity through my percieved process (remember im a newb!) will start with Business Model package and work down through each view for each discipline applied iteratively. Each view will contain models, information, linked files, etc to support the system I am building.

regards

Ian

« Last Edit: March 12, 2004, 02:45:12 pm by fluxtah »

sargasso

  • EA Practitioner
  • ***
  • Posts: 1406
  • Karma: +1/-2
  • 10 COMFROM 30; 20 HALT; 30 ONSUB(50,90,10)
    • View Profile
Re: Best Practices
« Reply #4 on: March 14, 2004, 03:22:51 pm »
Here's the biggest tips I could give anyone starting to use EA on a real system.

[glb]1) Decide early and clearly what your reasons for using the tool are![/glb]
To me there are three general ways you can use EA (or indeed most of the good UML tools):

As a power tool
  • A repository based approach (method) is fundamental
  • Use all the tool's features - avoid having external (unintegrated) utilities such as issue logs, change logs etc
  • Documentation is secondary as it is a snapshot of the analysis or design at a particular point
  • The repository is an asset of the system, not the project, and as such must be treated with the proper respect.

As a craftsman tool
  • System design remains bound to external documentation
  • Use the majority of the tool features to design the document content
  • Don't expect to glean the benefits of re-use - it wont happen in a document bound methodology.
As a handyman tool
  • Uses a limited set of the tool's features
  • Analsysis and design information is still in documents
  • IOW, the tool is used as a drawing tool only


[glb]2) Decide what the scope of usage of the tool will be[/glb]

Information Gathering, documentation & review
  • Requirements
    • Business and system

  • Design
    • Logical and technical
    • Software and data
    • Architecture

Maintenance & Enhancement
  • Round trip engineering

Testing
Project Management

[glb]3) Define a suitable repository structure[/glb]
(This bit relates to the original question)

If your intended use is focussed more towards "power tool" use and/or wider scope, then spend a good deal of time determining the proper structure for your teams' use of the system.  (or hire a good process consultant - I could name one in particular ;D)

The structure you pick should be built with one idea in mind - communication of the analysis and design decisions.  Don't worry about getting the structure "right" for the tool users only as it is covered by the last tip below

Provide "work in progress" areas for analysts and designers to use informally - i.e. as scratch pads while they analyse and design.  Once the team has agreed that a model component has been adequately worked, move the elements into the formal model structure. IOW:

[glb]4) Dont use the formal structure branches as a working area[/glb]

I have been using EA for over three years now, as my preferred tool.  Each client I work with has their own formal model structure, developed (albeit from a general model set) to suit the particular culture of the organisation concerned and the level of formal communication needed for system decision making.  Indeed one of the strengths of EA is the ability to set  up a tailored structure - my current client has had me working on the repository structures (amongst other things) for the last 4 months. We use several "starter models" dependant on the technology of the system involved (desktop, internal multiplatform, web app, etc) So even within an organisation it is possible that more than one model structure is viable/needed.
Given that the organisation is "large" and much formal communication is necessary in the majority of projects - we have based the structure on the traditional IT development phases: Requirenments, Analysis, Design, Implementation - as in this case there are viable reasons for keeping such models separate.

Good Luck!
Bruce
"It is not so expressed, but what of that?
'Twere good you do so much for charity."

Oh I forgot, we aren't doing him are we.

thomaskilian

  • Guest
Re: Best Practices
« Reply #5 on: March 15, 2004, 03:46:19 am »
There is also a good example EAP file coming with the EA distribution. Have a look at EAExample.eap. There are several structures (also some of which Ian and Bruce suggested). Make a template starting with this file and keep on improving it / making different flavours. HTH more than my first post.

Cheers,

Thomas