W3C home > Mailing lists > Public > public-sdw-wg@w3.org > September 2016

Referencing UCR requirements in other documents: not by number

From: Frans Knibbe <frans.knibbe@geodan.nl>
Date: Tue, 27 Sep 2016 12:17:54 +0200
Message-ID: <CAFVDz40DGP8fy0jUdwzzk-HicyE=w8kJ0s25p9n5GcBUTWGStA@mail.gmail.com>
To: SDW WG Public List <public-sdw-wg@w3.org>
Hello,

A note for everyone (especially document editors) referencing requirements
from the Use Cases and Requirements document: When reading the draft of the
note Publishing and Using Earth Observation Data with the RDF Data Cube and
the Discrete Global Grid System <http://w3c.github.io/sdw/eo-qb> I noticed
that requirements in the UC&R document are referred to by number, e.g. [Req
5.40 <https://www.w3.org/TR/sdw-ucr/#SpatialMetadata>]. I would like to
point out that fragment identifiers (e.g. #SpatialMetadata) can be
considered stable, but the numbering of the requirements is not. Section
numbering is handled by ReSpec and can change when requirements are added
or removed. So it is better to refer to them by their title, which should
be short enough. For example: Spatial metadata
<http://w3c.github.io/sdw/UseCases/SDWUseCasesAndRequirements.html#SpatialMetadata>
, spatial metadata requirement
<http://w3c.github.io/sdw/UseCases/SDWUseCasesAndRequirements.html#SpatialMetadata>
.

Regards,
Frans
Received on Tuesday, 27 September 2016 10:18:29 UTC

This archive was generated by hypermail 2.4.0 : Thursday, 24 March 2022 20:31:26 UTC