Book a Demo

Author Topic: Use Case Conventions (NOT formatting)  (Read 6215 times)

Gary W.

  • EA User
  • **
  • Posts: 139
  • Karma: +0/-0
    • View Profile
Use Case Conventions (NOT formatting)
« on: February 26, 2007, 03:27:37 pm »
Hi,

There's lots of good discussions on formatting the text, but I have a more practical question.  I've accepted that there are no bold/italics/bullets/tab controls in the Use Case elements in EA.

So, how do people enumerate the:
a. actors involved (not just the primary one)
b. level of the UC (e.g. Alistair's sea-level, sky-level, etc)

Do people just put the whole text into the NOTES (on the first tab)?  This would be 'free form text' versus distinct data elements.

Or do people still put preconditions and postconditions into the Constraints (3rd tab), putting nothing into the Scenarios (5th tab)?

As an aside, what do people use Files (last tab) for?  Does anyone actually link to Word Documents with formatted Use Case specifications?

TIA
Gary



peter.zrnko

  • EA User
  • **
  • Posts: 253
  • Karma: +0/-0
    • View Profile
Re: Use Case Conventions (NOT formatting)
« Reply #1 on: February 27, 2007, 12:18:50 am »
I'm trying to use Alistair's Cockburn methodology.

I'm using tags for:
- Scope (enumeration)
- Level (enumeration)
- Primary actor (from actors)
- Frequency (text)
- Open issues (memo)

I'm using constraints for:
- Preconditions
- Trigger
- Actors and interests
- Minimal end conditions
- Success End Condition

I'm using scenarios:
- basic path
- alternate

And also I'm using basic elements fields:
- Name
- Author
- Status
- Notes (Goal in Context)
- Version

I've made a profile with these tags and constraints and also a rtf template.

I don't use files. I prefer to to specify UC with EA things (tags, constraints). Formatting in rtf template is not so good, but everybody can see every part of use case in the model.

Does anybody use "Linked document" feature for UC?
Peter

thomaskilian

  • Guest
Re: Use Case Conventions (NOT formatting)
« Reply #2 on: February 27, 2007, 02:43:22 am »
I do it more or less like Peter. I have also not used the linked doc (I'm back at my TeX roots). I use the files tab to refer to additional documents (e.g. paper copies of documents being used in the UC and such stuff).

Regarding the enumeration I simply use a numbering scheme which can be implemented by EA's auto-numbering. That means "AC<nnn> <shortname>", "UC<nnn> <shortname>" etc. If the project needs it more sophisticated, you're forced to do it manually.

pitr

  • EA Novice
  • *
  • Posts: 4
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Use Case Conventions (NOT formatting)
« Reply #3 on: April 05, 2007, 12:23:40 am »
Hi Peter,

Quote
I'm trying to use Alistair's Cockburn methodology.

I'm using tags for:
- Scope (enumeration)
- Level (enumeration)
- Primary actor (from actors)
- Frequency (text)
- Open issues (memo)

I'm using constraints for:
- Preconditions
- Trigger
- Actors and interests
- Minimal end conditions
- Success End Condition

I'm using scenarios:
- basic path
- alternate

And also I'm using basic elements fields:
- Name
- Author
- Status
- Notes (Goal in Context)
- Version

I've made a profile with these tags and constraints and also a rtf template.


Can you elaborate on how to create such a profile?

Kind regards,

Pieter

Jan ´Bary´ Glas

  • EA User
  • **
  • Posts: 408
  • Karma: +0/-0
  • Bary
    • View Profile
Re: Use Case Conventions (NOT formatting)
« Reply #4 on: April 05, 2007, 03:16:54 am »
Quote
Does anybody use "Linked document" feature for UC?

Yes my coworkers on another project are. If anyone interested in just ask.
I do not use it, as I use scenarios on my sequence diagams in a note. But they say, for them is Linked document better (the customer prefers "nice" things).
Jan 'Bary' Glas

drain

  • EA Novice
  • *
  • Posts: 5
  • Karma: +0/-0
  • I'm Batman.
    • View Profile
Re: Use Case Conventions (NOT formatting)
« Reply #5 on: April 05, 2007, 07:09:50 am »
>  So, how do people enumerate the:
> a. actors involved (not just the primary one)

the actors involved are documented with a use case diagram. if there are multiple actors involved in a use case, the association between the initating actor and the use case is named "initiator". do not follow the method of tagging actors as primary or secondary as sometimes actors, in the overall system, can be primary and sometimes they can be secondary. then there are actors that are essentially equals where no one is primary or secondary.

when you write your "system" use case description, it should follow the sequence of "actor action; system reaction, actor action; system reaction, actor action; system reaction, ...". the very first "actor action" identifies the initiating actor. any other actors involved in the use case are identified in the text either as an actor with associated action or an actor the system asychronously interacts with (ie. system transmits bill to billing system {actor}).

there is no need to "enumerate" your actors in some special section. it will likely be a waste of effort and something that goes out of date as people focus on updating the use case description.

> So, how do people enumerate the:
> b. level of the UC (e.g. Alistair's sea-level, sky-level, etc)

i am not familar with alistair's approach, but from a distance it looks pretty silly. i am a student of jacobson, the creator of the use case approach. in the unified process  you will find two types of use cases: system and business. you will also discover the concept of "business goals".

a "system" use case model defines the functional requirements of a software system. it does not define system "goals" (sky level) as goals can be written quite wishy-washy (non-testable). this sky level approach sounds closer to the business goal approach found in the unified process' business modeling extension.

alistair's work sounds like its trying to throw the whole universe into one use case model. that wont work. it will be so big that you wont be able to understand it. your "system" use case model should just capture the functional software requirements of the system. you will likely need an associated requirements trace matrix to capture such non-functional requirements such as software architecture requirements and performance requirements. you will likely need a business goal model to capture business goals such as reduce operator workload and improve battlespace visualization.

the unified process is not just one model, but a series of models with tracability throughout.

> Do people just put the whole text into the NOTES (on the first tab)?

yes, use a use case template.

> Or do people still put preconditions and postconditions into the Constraints (3rd tab), putting nothing into the Scenarios (5th tab)?

no. thats too much interaction with the tool.

> As an aside, what do people use Files (last tab) for?

attaching documents that support or provide background information regarding the use case. for example, an interface design document.

>  Does anyone actually link to Word Documents with formatted Use Case specifications?

i dont. that too much spawning of processes. one should be able to quickly traverse the use case model just by clicking on use cases and seeing the associated notes.

>>>>

tagged values are used as part of a UML profile. you shouldnt need a profile to do basic system use case modeling.



Gary W.

  • EA User
  • **
  • Posts: 139
  • Karma: +0/-0
    • View Profile
Re: Use Case Conventions (NOT formatting)
« Reply #6 on: April 05, 2007, 11:38:57 am »
Quote
>So, how do people enumerate the:
> a. actors involved (not just the primary one)

the actors involved are documented with a use case diagram.
Well, the actors are *displayed* or *presented* on the diagrams.  But the enumeration, per use case, is something I want to be independent of the diagram.  I'd like the text to be stand-alone, with the diagram as supporting documentation.

Quote
>if there are multiple actors involved in a use case, the association between the initating actor and the use case is named "initiator". do not follow the method of tagging actors as primary or secondary as sometimes actors, in the overall system, can be primary and sometimes they can be secondary. then there are actors that are essentially equals where no one is primary or secondary.
Interesting... I'm used to the convention that an actor is deemed 'primary' in the context of a Use Case.  However, I can see the value of labelling the association as 'initiator" versus labelling the actors as 'primary'.

Quote
>alistair's work sounds like its trying to throw the whole universe into one use case model. that wont work. it will be so big that you wont be able to understand it.
Please don't judge his work based upon my posting; I'm sure I've left out lots of content and/or simplified his methods.

Quote
Or do people still put preconditions and postconditions into the Constraints (3rd tab), putting nothing into the Scenarios (5th tab)?

no. thats too much interaction with the tool.
Well, I'd prefer to have my requirements stored as discrete elements following the tool's data model.  But, I can see your point too.. especially here as now they have to click back and forth between the tabs to see the whole story.

Quote
i dont. that too much spawning of processes. one should be able to quickly traverse the use case model just by clicking on use cases and seeing the associated notes.
Yes, I can see the benefits to doing it as you've described.  Now if only there was some way to format the text...  ::)

But then again, that's a whole other thread and wasn't the point of my original posting.

Thanks for the advice,
gary

jbettencourt

  • EA Novice
  • *
  • Posts: 16
  • Karma: +0/-0
    • View Profile
Re: Use Case Conventions (NOT formatting)
« Reply #7 on: April 13, 2007, 12:26:13 pm »
Quote
Yes my coworkers on another project are. If anyone interested in just ask.


I'm interested.  We're debating using the scenarios and constraints included in the elements model or using individual Word documents for each use case.  We're sure we'll be able to draw a cleaner picture with Word for our stakeholders but we're concerned about reporting.  Ideally, we could run a use case report from EA and embed the contents of a linked document (the use case in Word) automagically.  What are your co-workers doing?

Thanks, Josh

bioform

  • EA User
  • **
  • Posts: 230
  • Karma: +0/-0
  • Forty-Two?
    • View Profile
Re: Use Case Conventions (NOT formatting)
« Reply #8 on: April 27, 2007, 05:34:27 pm »
I gave up with trying to use EA's RTF features to generate documentation...

I have had GREAT success with the following approach...

1. Model lives on a RDBMS...
2. Use Access to link to the SQL tables... and then write code/forms/reports... to massage project data locally in access (e.g., extract info from the model, then format, flatten, etc. to create a fully dressed usecase(s), and generate RTF documents...)
3. Use Word's MasterDocument features to include RTF docuemnts (some code is ran to clean up RTF to DOC problems that have been around for ever, and database fields to embedd live queries to either the model, or the access database

Everytime I demo/train users, that are just amazed...

I am currently mapping our CMMI processes to Unified Process activities, and then mapping those down to my SOPs for modeling using EA.

This is allowing us to concentrate on the analysis/modeling and generate requirement, testing, and soon our design documents on demand...

Takes some work, and thought, but a pretty nice way to enhance EA, and at the same time proto-type Add-ins once you have the business side of it ironed out...
Time is what keeps everything from happening at once, Space is what keeps it all from happening to you. <unknown>