W3C home > Mailing lists > Public > site-comments@w3.org > December 2017

Final CG report publication form is confusing

From: Francois Daoust <fd@w3.org>
Date: Thu, 21 Dec 2017 07:25:03 +0100
To: <site-comments@w3.org>
Cc: "'Vickers, Mark'" <Mark_Vickers@comcast.com>
Message-ID: <003301d37a24$813805a0$83a810e0$@w3.org>
Hello there,

The Web Media API Community Group just published a final report of the Web Media API Snapshot 2017 specification. Exchanging with Mark Vickers, CG chair, while preparing that publication, we noted that the instructions on the publication form are somewhat misleading:

1. The description of the "URI of Final Specification" does point out that the report must be published on w3.org, but the existing text makes it sound as if our system will just handle the actual publication itself, and copy the latest version of the draft report somewhere on w3.org. The FAQ is not any clearer. The text should clearly say that the actual publication is a prerequisite to filling out this form, and should provide some guidance for how this can be done (be it only with a "get in touch with your nearest W3C team contact", which may be enough given that most CGs that publish final reports somehow have a connection with someone on the team. Sending an email to site-comments@w3.org could be an option too). That first step will give the URI to enter in the form.

2. The use of the term "publishing" is ambiguous. It can mean "copying the doc to a location" and "filling out the form". Typically, the term is used with both meanings in the description:
 - "Final Reports must be *published* on the W3C web site" (copying the doc)
 - "Learn more about how to *publish* a report" (filling out the form)
The former term could perhaps be replaced by "copying". The latter term could perhaps be replaced by "announcing".

3. Looking at the FAQ for possible instructions on how to get a URI on the w3.org domain name, one will bump into "Can I use W3C namespaces in our Specification?":

This entry states that the URI https://www.w3.org/ns/[shortname] may be used. That will only add to the confusion:
- the notion of namespace can be somewhat foreign to "API people"
- as such, it reads like an invitation to use that URI for the final report, which is not what we want.

The notion of namespaces could perhaps be clarified by linking to the Namespaces in XML spec that defines what we mean by namespaces, as done in our URIs for W3C Namespaces policy for W3C Technical Reports:
(although the dependency on "XML" feels a bit outdated nowadays)

Received on Thursday, 21 December 2017 06:25:40 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:52:55 UTC