Book a Demo

Author Topic: Communicating Your Design to Developers  (Read 5183 times)

DMT

  • EA User
  • **
  • Posts: 93
  • Karma: +0/-0
    • View Profile
Communicating Your Design to Developers
« on: June 05, 2003, 07:05:51 am »
OK.  You've detailed the requirements. You've built the use case model, detailing all of the basic and alternative flows to realize those requirements. You've completed the mock-up of the UI, and written requirements and scenarios on reusable UI controls. You've created the sequence diagrams and designed all of your classes,  database tables, and stored procedures.

Now what?

I'm interested in hearing about the most effective ways other people have found to communicate all of the wonderful information in EA to the developers.

What I'm envisioning is that I'd create a project plan that would direct them in (generally) the right direction, as follows:

1. I make a project plan that outlines the use cases to be implemented as a deliverable.
2. For each of the use case "deliverables," it will include a list of the associated UI screens that are required (this is so the UI designer can be assigned the tasks of mocking them up) as well as general tasks such as "stored procedures," "UI controls," and "business classes."

This is all great.  What I'm trying to figure out is the best way to deliver this stuff.  I really like the HTML documentation, but there's no way to search!  How is my developer going to find the "Create Widget" use case buried down 2 package levels deep?  (Use cases\Widget Management or something like that)

Do I nix the HTML idea and just create RTF docs for each use case?  This is a pain, because the docs are created at the package level.

Basically, the problem I'm trying to solve is the developer starting work on a use case, and instantly being able to put his hands on all of the information he needs.

I wonder if the easiest way is to simply associate the use case with all of the classes, UI screens, and requirements. Then, the developer could just click on each hyperlink on the use case page to get to the associated information.

Anyhow, I'm not sure of what the right answer is, so I'd love to hear how others have "packaged up" the information the developer needs to implement a particular use case.

fwoolz

  • EA User
  • **
  • Posts: 435
  • Karma: +0/-0
  • We have met the enemy, and he is us.<Pogo, 1970>
    • View Profile
Re: Communicating Your Design to Developers
« Reply #1 on: June 05, 2003, 09:50:54 am »
DT,

I know of one forum member who turns the RTF docs into HTML using a script.  I have been working on turning RTF documents into HTML by saving them as filtered HTML (i.e., HTML w/o all the MSO XML tags) from Microsoft Word.  I then go back to the EA diagrams and add hyperlinks to the bookmarked section of the HTML doc just created.  Right now there's a bit of manual work involved in properly formatting all the bookmarks (also in back-annotating the EA diagrams with hyperlinks), but I think it holds some promise as a way to tie the text & model worlds together.  I'm also toying with a process that goes like this:

EA->RTF->Well-Formed HTML->Intermediate XHTML->XSLT->Output XHTML

Ultimately, I'd like to try spitting out IEEE-like software docs this way (as soon as they approve of the 50-hour day!).

Cheers,
Fred Woolsey
Fred Woolsey
Interfleet Technology Inc.

Always be ready to laugh at yourself; that way, you beat everyone else to the punch.


Steve_Straley

  • EA User
  • **
  • Posts: 183
  • Karma: +0/-0
    • View Profile
Re: Communicating Your Design to Developers
« Reply #2 on: June 22, 2003, 10:10:03 am »
Fred,

You actually hit on one of the main goals of our recent released product.   In working with some of the other "suites" I found it totally absured to UML model in one product, build text documents in another, and then generate the comibed reports in a third.  So one of our goals was to allow a "diagram" in EA to be tagged within the text generation and when the documents are created, to pull the diagram over.   In that, the "requirements management" and subsequent text are held in a separate repository (allowing for traceability).

Cheers,

Steve
Steve Straley