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 7: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

As Business Analysts in Agile teams, we often hear about Definition of Ready (DOR) and Definition of Done (DOD). But beyond the buzzwords, these two concepts are powerful tools to drive clarity, consistency, and quality in our work. Definition of Ready ensures a user story is truly ready for development. It answers: Is this story clear, feasible...
In today's fast-paced digital world, successful projects aren't just built on great code—they're built on clarity. And that clarity often comes from one key player: the Business Analyst. At the heart of every great product or system is a need—a business goal, a customer pain point, or a regulatory requirement. But busines...
I have always loved cooking. I learned from my Grandma June and her kitchen was her sanctuary, a small, warm sunlit space filled with jars of spices, stacks of cookbooks, and the comforting smell of something always on the stove or baking in the oven. Grandma June was as great a cook as she was a teacher to me. She never followed a recipe “to...

 






 

Copyright 2006-2025 by Modern Analyst Media LLC