Forums for the Business Analyst

 
  Modern Analyst Forums  Business and Sy...  Structured Anal...  Writing Requirements to Develop API
Previous Previous
 
Next Next
New Post 6/22/2010 2:24 PM
User is offline ivar
1 posts
No Ranking


Writing Requirements to Develop API 
Modified By ivar  on 6/22/2010 3:24:40 PM)

Writing Requirements to Develop API

How can a Business Analyst add value on project where the deliverable is API (Application Programming Interface) and NO user interface?

What kind of requirements artifacts to produce?

Any ideas appreciated?

 

 
New Post 6/22/2010 3:00 PM
User is offline David Wright
141 posts
www.iag.biz
7th Level Poster




Re: Writing Requirements to Develop API 

 

People are not the only Actors who need to interact with your system, so do other systems. It would seem that you treat one or more systems as one type of Actor whose needs are met by the API. The interesting point when it is recognized that maybe some systems need a slightly different API, or changes to the API are needed to make it flexible enough to support different Actors., and from a Requirements perspective, those are different Actors no matter how an API is built.


David Wright
 
New Post 6/24/2010 5:49 AM
User is offline Bob Savage
1 posts
No Ranking


Re: Writing Requirements to Develop API 
You can still benefit from a basic functional analysis (e.g. Use Cases) or data flow analysis (DFD). You might also want to dig deeper and do an analysis of dependencies, or document deployment practices, these things depend upon your setting. The trick is, since you won't have much variety in the types of actors, you don't want to get overcomplicated. Think about who is using the API, and how they will be using it (possibly this will generate different scenarios for common usage patterns). Then document what the various user goals would be (this is precisely a Use Case); you want to document at least the goal, and any pre-reqs, any minimal guarantees, etc. You can get away with just documenting the parameters supplied and the return type (and possibly side-effects), instead of the interaction details. Note: the parameters and the return value (and possibly side-effects) can also be viewed as the data flows if you choose to go the DFD route instead. Best of luck.
 
Previous Previous
 
Next Next
  Modern Analyst Forums  Business and Sy...  Structured Anal...  Writing Requirements to Develop API

Community Blog - Latest Posts

Jason White
Jason White
With time, we have evolved from oiled lamps to ever-present electricity, printing every page manually to now producing thousands of copies a day and so on. But what is the one thing these distinct things have in common? Yes, technology.One such branch of technology that has crossed leaps and bounds and turned into a  working technology fr...
1 Responses
Digital Business Analysis
Digital Business Analysis
Nowadays, companies like Audi and HSBC, use IT systems in everything they do. Does that make them to be IT companies rather than banks? Most would probably agree that HSBC is a bank, just as Audi is a car manufacturer. But what about digital banks such as Chime or companies offering digital products? In digital companies, most of the employees work...
1 Responses
Digvijaybook
Digvijaybook
IT companies are rapidly looking or adapting modern methodologies, so the business analyst role is increasing day by day. Offline is shifting to online, and this is why today, companies can easily garner important data in any aspect. But, data itself has no meaning hence, organizations look for a business analyst who can analyze the data and draw a...
3 Responses






Latest Articles

Rethinking the Triple Constraint: Five Project Dimensions
Feb 17, 2020
0 Comments
Perhaps you’ve seen a sign at an auto repair shop that asked, “What do you want: good, fast, or cheap? Pick two.” While humorous, th...
Copyright 2006-2020 by Modern Analyst Media LLC