ISSUE-70: Should we have use-cases in specifications


Should we have use-cases in specifications

APIs — General
Raised by:
Max Froumentin
Opened on:
Should specifications have a use-case section? Or should the decision be made on a case-by-case basis?

Max's claim: Use-cases (and requirements) are helps, meant for writing the specification itself, but not part of the specification. Examples are ok, as they help the implementer get a quick overview of a specific API, but use-cases are just as well replaced by more generic wording saying "this specification enables webapps to do XXX, YYY and ZZZ".
Related Actions Items:
No related actions
Related emails:
  1. Re: Publishing System Information API FPWD (from on 2010-01-27)
  2. ISSUE-70 (usecases-in-spec): Should we have use-cases in specifications [APIs — General] (from on 2010-01-27)

Related notes:

We resolved to leave that up to the editors, as they see fit; closing

Dominique Hazaël-Massieux, 25 Aug 2010, 16:21:02

Display change log ATOM feed

Anssi Kostiainen <>, Reilly Grant <>, Chairs, Fuqiao Xue <>, Staff Contact
Tracker: documentation, (configuration for this group), originally developed by Dean Jackson, is developed and maintained by the Systems Team <>.
$Id: 70.html,v 1.1 2019/11/08 08:58:57 carcone Exp $