W3C home > Mailing lists > Public > public-i18n-core@w3.org > January to March 2015

Re: Spec developer techniques

From: Richard Ishida <ishida@w3.org>
Date: Tue, 24 Mar 2015 14:45:42 +0000
Message-ID: <55117896.1050109@w3.org>
To: public-i18n-core@w3.org
update


the location of the document at http://w3c.github.io/bp-i18n-specdev/ 
leaked into the twittersphere and generated a bit of activity

it appeared clear to me that people will expect to find all the 
information available by looking in the document itself, and that it 
would be too complicated to constantly explain that you should start 
with the techniques page at 
http://www.w3.org/International/techniques/developing-specs, instead, 
which may have additional information, and only look in the former doc 
for explanations that can't be found elsewhere.

so i changed the doc at http://w3c.github.io/bp-i18n-specdev/

it now contains 'mustard' for all the recommendations in the techniques 
page, and links to where to find details, if they are in the doc itself 
(i don't want to duplicate information - we already struggled on that 
account before).

to make this a bit more manageable, i also implemented a way to 
automatically extract the markup that will be used in the techniques 
pages (dynamic and non-dynamic use the same content).  This means that 
it's easy to add the content needed to both the files.


i also played with and hopefully improved the styling and made it 
possible to link to more than one place for additional information, if 
needed.

i also made a stab at some additions prompted by Mati's feedback.

ri



On 18/03/2015 12:00, Richard Ishida wrote:
> [sent to public-i18n-core since this is still very early draft]
>
>
> folks,
>
> in the past couple of telecons we discussed the idea of improving our
> outreach and information for spec developers. The goal is to document as
> many useful guidelines as possible so that WGs can self-direct wrt i18n
> topics from and early stage in their spec development process, and
> hopefully therefore reduce the burden on us during review and subsequent
> discussion.
>
> over the past few days i have done the following:
>
> [a] added the information at
> https://www.w3.org/International/wiki/Bp_spec_bidi
> to
> http://www.w3.org/International/techniques/developing-specs
>
> [b] simplified the markup and styling for the latter page, to make it
> easier to update in future
>
> [c] created
> http://w3c.github.io/bp-i18n-specdev/
> as a place where we can add explanations, examples and rationales for
> the checklist items in
> http://www.w3.org/International/techniques/developing-specs
> This doc is in github, so proposals for text can be submitted that way.
>
>
> these are just early hacks at the information – please review and make
> suggestions for improvements. As well as comments on what's there, your
> suggestions can include proposed explanatory text as well as proposals
> for additional recommendations. While we are doing reviews, we should
> keep in mind that any comments we make should be converted to guidelines
> where possible.
>
>
> cheers,
> ri
>
>
Received on Tuesday, 24 March 2015 14:45:47 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 24 March 2015 14:45:48 UTC