Forums for the Business Analyst

 
  Modern Analyst Forums  Business and Sy...  Requirements  Ideal Requirements Documentaion
Previous Previous
 
Next Next
New Post 1/2/2008 6:43 AM
User is offline VN
34 posts
9th Level Poster




Ideal Requirements Documentaion 
Hi
I am trying to prepare a template with some guidelines, etc. that could be used by novice BA's who have mostly theoretical knowledge and not enough experience. I started to ask myself, what should the ideal requirements document(s) contain from developer's and tester's point of view as these are the people using it the most. 
 
The response from the programmers I work with has been that the diagrams (activity, sequence, etc.) are the most important part. They suggested that each use case flow description is followed by a diagram either specific for that flow or highlighting it on the use case diagram.
 
The testers said that the use case textual part with the different scenarios is nice and suggested incorporating more variations that they will test.
 
Both teams said that logical categorization and numbering of the non-functional requirements helps them as well.
 
My question to the forum is:
What comments have you received on the requirements documentation from the people who use it?
 
I will appreciate if you respond based on your experience as I am looking for real life input.
We are utilizing Use Cases and UML but comments from any other methodology or documentation type applied in the practice are welcomed too.
 
Thank you very much,
 
Vessela
 
 
New Post 1/2/2008 7:58 AM
User is offline David Wright
141 posts
www.iag.biz
7th Level Poster




Re: Ideal Requirements Documentaion 

Hi Vessela,

Have a look at http://searchsoftwarequality.techtarget.com/tip/0,289483,sid92_gci1252666,00.html , it summarizes what artifacts I think are needed when doing Business Analysis and Requirements, including how they all fit together.

Dave W


David Wright
 
New Post 1/3/2008 6:38 AM
User is offline VN
34 posts
9th Level Poster




Re: Ideal Requirements Documentaion 

Hi Dave,

I read your article. It is very informative and has the real life comments I am looking for.

I have only one comment. I personally think that using data models in requirements documentation is limiting the implementation, as the BA may not have the best knowledge of relational database design, etc when compared to a DBA for example. I have also noticed that if such a model is present in the requirements the client then assumes that the final database will have tables and fields as in this document. For this reason I would recommend the usage of a  UML class diagram.  You can represent multiplicity, composition, etc. During the  requirements gathering process it provides the high level overview the clients need and then the person designing the database will be allowed to apply the best practices as needed.

Thanks,

Vessela

 

 
New Post 1/3/2008 9:06 AM
User is offline David Wright
141 posts
www.iag.biz
7th Level Poster




Re: Ideal Requirements Documentaion 

Yes, Data Models and Class Models are virtually interchangeable for capturing Entities and Relationships, so I am a strong believer in "if it works for you, do it".

...but I have some follow-up thoughts and experiences (of course!)

I worked with a development team once that was adamant that a Class Diagram was their model for software design and architecture, and I should not use it for requirements. This was a very object-oriented team, and they were also struggling with how to model persistent data. The key disconnect was that their Class Diagrams usually had the Class of interest, like a Product Order, as the 'parent' to all other Classes, like the Customer who made the order. This made sense from a software viewpoint, as an instantiation of the Order for use in a program only cared about the one Order, but from a database view, you want to know other things, like how many Orders a Customer has made. This led to the definition of data-holder/getter classes that mirrored the data model, and were used to get data from the database. The developers were originally antsy about these classes, as they  had no methods of interest, and that felt so wrong to them...but they got past that.

So, I personally avoid Class Diagrams if there can be any confusion about whether they are data diagrams or software diagrams. Further, when I use Data Models (and the local methodology I am using supports this), I clearly move the model through stages of Conceptual, Logical and then, working with the DBA, get to a Physical model. I have found the business people can see this transformation and understand why it is done, so expectations can be managed.


David Wright
 
New Post 1/3/2008 10:00 AM
User is offline Adrian M.
765 posts
3rd Level Poster




Re: Ideal Requirements Documentaion 

I use Class Diagrams extensively during the requirements stages of the project.  I use it to create an artifact called "Business Entity Model" and it serves as the foundation for all requirements work.  The purpose of this document is to show the "things" of the business.  It is used to define all the business concepts related to the project.

Here are a couple of quick points about the Business Entity Model:

  • Is a class diagram with every class representing a business entity,
  • It's a logical model (should not be impacted by design/physical implementation),
  • The business entities are from the business user's perspective (these are NOT implementation classes),
  • Is generally accompanied by a document which defines each business entity in plain language,
  • Shows the relationships between the entities (classes),
  • At the requirements state, the entities generally do not include attributes (data), though the business description may mention key attributes in order to ensure that everybody understand the type of business object being described,
  • Is used to remove ambiguity from requirements discussion with the business stakeholders and to ensure that everybody is on the same page.

This is one of those artifacts which should exist for EVERY project.  The modeling notation is not as critical (Class Diagram vs ER Diagram) as the importance of focusing on the entities from the business perspective and keeping the model logical.

Hope this helps!

- Adrian


Adrian Marchis
Business Analyst Community Blog - Post your thoughts!
 
Previous Previous
 
Next Next
  Modern Analyst Forums  Business and Sy...  Requirements  Ideal Requirements Documentaion

Community Blog - Latest Posts

In today's ever-evolving market, businesses must adapt swiftly to remain competitive and meet the needs of a fast-paced digital economy. Among the various business strategies available, digital transformation, customer-centricity, and sustainability have emerged as top priorities. Let’s explore why these strategies are critical for busine...
The Cisco Certified Network Associate (CCNA) certification is a pivotal credential for networking professionals, validating your skills in networking fundamentals, security, automation, and programmability. Preparing for the CCNA exam can be challenging, but with the right strategy, resources, and mindset, you can successfully achieve this certific...
The CEO/CIO's Guide to Architecting AI: Vision to Value in Minutes Introduction to Architected AI Artificial intelligence (AI) is becoming part of our life at an unprecedented pace. As CEOs and CIOs grapple with how to leverage this powerful technology to drive strategy and enhance operations, the concept of Architected AI becomes importa...

 



Upcoming Live Webinars




 

Copyright 2006-2024 by Modern Analyst Media LLC