Hi every one,
I was given a task to make a document that goes to developers to developa Interface where they have to call the webservice to get data from the client server and store into our database.
So I prepared a document by using a sequence diagram which shows the flow.
My high level rquirement are clear, so can we go further deep to show the requirements in clear.
Thank you,
Regards,
Srikanth.
Srikanth,
Without knowing far more about the environment that you are modeling it's hard to say what else you should provide. Certainly some kind of documentation of the data that is passed as input and output from the webservice would make sense. It's great that you have made a sequence diagram. Beyond that you should meet with the developers and see what they might need beyond what you have provided. Remember, your audience is the developer.
In conjuction with the inputs and outputs, it would be benefical to document the data structures and schema as well as the web service calls.
I am a BSA, sometimes I need to design and document data structure and schema. But for general BAs, I guess it should be too technical. Theoretically system architect or tech lead might be a better person for those, since I think data structure and schema are key parts of technical design.
This is just my two cents...
brought to you by enabling practitioners & organizations to achieve their goals using: