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

If you're looking to visualize, analyze, and share data insights with ease, Power BI might be the solution you need. In this article, we'll cover what Power BI is, why it's important, and how to get started with it. What is Power BI? Power BI is a business analytics service provided by Microsoft that helps users visualize and anal...
How to Write Business Analyst Resume
Business analysts must have an up-to-date, visually appealing resume to be able to stand out from the competition. A strong business analyst resume should accurately reflect your skills, experience and qualifications while also highlighting your accomplishments and successes. We will provide invaluable advice on how to build a strong, effective bus...
Are you testing your product in the most effective way?
Today covid-19 pandemic has completely flipped the business model. Various conventional Business models like banking and health had to adopt the digital era. Even the school and colleges have to create various applications so that they can provide online learning for their students. All these statements justify the modern business model as complete...



Copyright 2006-2023 by Modern Analyst Media LLC