RE: ISSUE-7: Gathering requirements [Calendar API]

To kick things off on the requirements, and considering my personal
philosophy in this WG that less is definitely more to begin with, I
would like to propose some initial thoughts on producing our lightweight
requirements.

In order to be lightweight I suggest that Key Functionality - general
statements that describe the intent of the given API - could be
sufficient as a starting point to defining high-level requirements.
Notes could also be included to support any of the key functionality.
Notes may suggest any 'soft' requirements (such as API style or pattern
requirements) or, as in the example below, object formats that should be
considered to support any key functionality.

Therefore, for the Calendar API...


Key Functionality:

* Create a new calendar event

* Update an existing calendar event

* Remove an existing calendar event

* Find existing calendar events

Notes:

* An iCalendar [1] format MUST be used to represent an 'event' object
throughout the Calendar API.


Does anyone expect any more than this in the first instance of API
requirements? Does anyone see the need to break down the key
functionality to medium and low level requirements at the beginning or
during the API creation phase?

Perhaps others have different views on the best process to use. For
example, an alternative proposal could be to begin with use cases and
work out the required functionality from there or to look at existing
implementations and identify the shared core functionality as the basis
for any given API (FYI, the Calendar API requirements included above are
a loose paraphrasing of BONDI Calendar API requirements).

br/ Richard


[1] http://www.ietf.org/rfc/rfc2445.txt


> -----Original Message-----
> From: public-device-apis-request@w3.org 
> [mailto:public-device-apis-request@w3.org] On Behalf Of 
> Device APIs and Policy Working Group Issue Tracker
> Sent: 25 August 2009 14:28
> To: public-device-apis@w3.org
> Subject: ISSUE-7: Gathering requirements [Calendar API]
> 
> 
> ISSUE-7: Gathering requirements [Calendar API]
> 
> http://www.w3.org/2009/dap/track/issues/7
> 
> Raised by: Robin Berjon
> On product: Calendar API
> 
> 
> 
> 
> 
> 

Received on Wednesday, 16 September 2009 16:33:19 UTC