W3C home > Mailing lists > Public > public-sysapps@w3.org > October 2012

Re: Process proposal

From: Adam Barth <w3c@adambarth.com>
Date: Fri, 26 Oct 2012 14:56:32 -0700
Message-ID: <CAJE5ia-hdRWeQR9oN3R1m2NpmzVQUGsAoxAeML5THZfRqrCE1w@mail.gmail.com>
To: Josh Soref <jsoref@rim.com>
Cc: sysapps <public-sysapps@w3.org>, Robin Berjon <robin@berjon.com>
As I mentioned on another thread, we haven't started to work on any of
these APIs yet.  The working group is currently gathering proposals.

I agree that we should be clear about which use cases we're addressing
and which use cases we're not addressing.  Rather than having a
dedicated "use cases and requirements" phase, we're first soliciting
proposals for our various deliverables.  My hope is that having some
concrete proposals to look at will let us have a more concrete
discussion around use cases and requirements.

Adam


On Fri, Oct 26, 2012 at 11:27 AM, Josh Soref <jsoref@rim.com> wrote:
> I've spent a bit of time in a number of groups and think that a lesson learned could be useful.
>
> CoreMob (really Facebook) did research into an area and then moved straight to trying to publish roughly a "specification".
>
> Then people asked "what UC/Requirements are you addressing?" (roughly: "why are you doing this?"), and CoreMob didn't have an answer - because it hadn't published its research.
>
> For defining an API, these are the things which I think should be answered:
>
> 1. [UC] What are the general Use Cases which you're trying to address?
> 2. [Req] What are the specific technical Requirements to address the UCs?
> 3. [API] How have others tried to address these UCs and Reqs?
> 4. [Use] Given others' APIs for these UCs/Reqs, what have people produced which uses this solution?
> 5. [QQs] What questions have people asked about others' APIs?
>
> * [UC]+[Req] can be published as a single combined Use Case and Requirements document, or as separate documents, but they should be published.
> * [API] can be initially a wiki and will probably end up in an informative appendix to a published specification.
> * [Use] should be a survey - roughly producing a spreadsheet, preferably with some charts showing popularity/use - preferably highlighting which UCs/Reqs are addressed/how well/how used.
> * [QQs] can initially be some sort of wiki/spreadsheet - it should show which are the most common causes of confusion / problems that aren't easily solved for the existing APIs. It doesn't need to be published per se, but being able to reference it informatively from the spec is useful "we tried to avoid (most) these problems when we wrote our specification". Sources for this include sites like "Stack Overflow" (as well as any group's actual FAQ pages).
>
> I think that SysApps (and really every other group) should keep this in mind when it tries to produce any API.
>
> ---------------------------------------------------------------------
> This transmission (including any attachments) may contain confidential information, privileged material (including material protected by the solicitor-client or other applicable privileges), or constitute non-public information. Any use of this information by anyone other than the intended recipient is prohibited. If you have received this transmission in error, please immediately reply to the sender and delete this information from your system. Use, dissemination, distribution, or reproduction of this transmission by unintended recipients is not authorized and may be unlawful.
>
Received on Friday, 26 October 2012 21:57:31 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Friday, 26 October 2012 21:57:32 GMT