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

There are big differences between data exploration versus data presentation. And you need to be aware of these differences as you're creating data stories and data presentations. Let’s start by defining our terms: Data exploration means the deep-dive analysis of data in search of new insights. Data presentation means...
Is Agile a reason to avoid documentation? I bet this question shows up again and again while working with product requirements. On one side, we have got long specifications, complicated diagrams, mystical technical design, too many prototypes and pretty obvious for engineers user guides (do we really need so much?). On the other side, can we actual...
The cloud-native application development has helped enterprises all around the globe reduce time-to-market, enhance performance, and develop agility and flexibility. Several enterprises are achieving these results by migrating their systems or traditional monolithic applications to the cloud. But to gain from the real benefits of cloud technology, ...

 






 

Copyright 2006-2022 by Modern Analyst Media LLC