W3C home > Mailing lists > Public > www-archive@w3.org > November 2009

Proposed W3C Spec Conventions

From: Doug Schepers <schepers@w3.org>
Date: Mon, 23 Nov 2009 03:44:21 -0500
Message-ID: <4B0A4B65.2080406@w3.org>
To: www-archive <www-archive@w3.org>
Hi, Folks-

(Forwarding and summarizing from Member-only space.)

I'm not the first one to suggest this (apparently Karl tried to push 
this earlier this year), but I really think it's time we establish some 
standardized style conventions for W3C specs.

I took a couple hours to pull together a proposal (attached) based on 
Karl's original along with feedback to that proposal, and conventions 
that I'm familiar with from the SVG and DOM3 Events specs; I'm not 
married to any of it, but any counter-proposals should probably stick 
with at least the level of granularity laid out here.

Please see the attached, and send in counter-proposals or thoughts for 
consideration.

I plan on using this (or whatever variant we all decide on) in the specs 
I'm editing (some SVG specs, DOM3 Events).  I encourage others to do the 
same, and report back what works, what doesn't work, what's missing, etc.

(Oh, and I'd really like to see this working with Robin Berjon's ReSpec.js:
  http://dev.w3.org/2009/dap/ReSpec.js/documentation.html )

Thanks!
-Doug Schepers
W3C Team Contact, SVG and WebApps \o/ WGs



Received on Monday, 23 November 2009 08:44:26 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Wednesday, 7 November 2012 14:18:27 GMT