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

Fabricio Laguna talks Business Analysis and AI
I recently connected with Fabricio Laguna, aka The Brazilian BA. Fabricio is a passionate and pioneering business analyst from Brazil. During our conversation, we had a thought-provoking discussion on how artificial intelligence stands to shape the field of business analysis in the years ahead. While AI promises to transform many aspects of busines...
Business Architecture, Ontology and More with Terry Roach
It's been a privilege meeting Terry Roach, a visionary in the field of enterprise architecture and business architecture. Terry's insights into the evolution of business models, the importance of ontology in architecture, and the potential of AI to shape our future were not only thought-provoking but also a reflection of his extensive exper...
Today I had the pleasure of chatting to Jignesh Jamnadas, Chief Operations Officer at Mosaic, about his Blueprints for Success. As a Senior Finance and Operations Executive, Jigs (as he is known to many) has a holistic understanding of all facets of business and a flair for managing both people and processes. Having worked with Jigs, I was struc...

 



Upcoming Live Webinars




 

Copyright 2006-2024 by Modern Analyst Media LLC