Forums for the Business Analyst

 
  Modern Analyst Forums  Business and Sy...  Requirements  Which artifact to use for describing how a system is built ?
Previous Previous
 
Next Next
New Post 3/22/2010 8:32 AM
User is offline Joakim
4 posts
No Ranking


Which artifact to use for describing how a system is built ? 

Hi all :-)

I'm about to write documentation for an already existing system. I.e read source-code and interview developers. The reasons are:
  • Detailed documentation for the system is not good enough
  • The documentation shall serve as requirement-input when a new system shall be implemented.
The result shall be possible to read by any stakeholder. Yet it shall describe details on a technical level.
I want to write something like this :
"1. The system receives the file and archives it without analyzing the content. The archiving serves auditing and history purposes.
2. The system detects the file’s message type and determines that the file is an XYZ Interchange file containing one or more AAA / BBB /messages.
3. Next, the system filters the file, removing any Carriage Return (CR) and Line Feed (LF) characters that may have been added during the file transfer. CR LF characters are never part of XYZ messages and must be removed.
..."

It looks like usecase but it's not. A usecase is more WHAT shall happen. Not HOW it is done.

Q1: Which artifact suits best to use for this kind of documentation? (Sequence-diagram perhaps? Diagrams might be tricky to understand for everyone though).
Q2: The system have ~100 unique scenarios that shall be described in this form. Most of them are very similar to each other, but with small differences here and then. How can I write so few "how-usecases" as possible and still fetch all details? Refer to a list of special requirement or similar?

/Best Regards
Joakim Carlsson
 
Previous Previous
 
Next Next
  Modern Analyst Forums  Business and Sy...  Requirements  Which artifact to use for describing how a system is built ?

Community Blog - Latest Posts

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...
In today's dynamic business environment, mastering effective business analysis techniques is crucial for organizations aiming to achieve sustainable growth and competitive advantage. Business analysis involves the systematic evaluation of business processes, requirements, and strategies to uncover insights that drive informed decision-making. T...
For many years now, a lot of people have found it difficult to identify the difference between Sankey diagrams and parallel sets. The two have made headlines, given that most people find it challenging to note what makes them different from each other. What remains to be undeniable is the fact that the Sankey diagram is among the top data visualiza...

 






 

Copyright 2006-2024 by Modern Analyst Media LLC