W3C home > Mailing lists > Public > public-webapps@w3.org > October to December 2015

[Spec Reviews] Internationalization Best Practices for Spec Developers

From: Arthur Barstow <art.barstow@gmail.com>
Date: Tue, 20 Oct 2015 06:44:49 -0400
To: public-webapps <public-webapps@w3.org>
Message-ID: <56261B21.8010405@gmail.com>
The I18N WG group published a FPWD of "Internationalization Best 
Practices for Spec Developers". This document includes recommendations 
and best practices for spec writers regarding topics such as characters, 
language, text direction, etc.

I presume this document (or a document like this) would be used (useful) 
when a spec is getting "wide review" from an internationalization 
perspective.

[[
<http://www.w3.org/TR/2015/WD-international-specs-20151020/>

*Abstract*

This document provides a checklist of internationalization-related 
considerations when developing a specification. Most checklist items 
point to detailed supporting information in other documents. Where such 
information does not yet exist, it can be given a temporary home in this 
document. The dynamic page Internationalization Techniques: Developing 
specifications 
<http://www.w3.org/International/techniques/developing-specs-dynamic> is 
automatically generated from this document. *The current version is 
still a very early draft, and it is expected that the information will 
change regularly as new content is added and existing content is 
modified in the light of experience and discussion.

Introduction

*Developers of specifications need advice to ensure that what they 
produce will work for communities around the globe.

The Internationalization (i18n) WG tries to assist working groups by 
reviewing specifications and engaging in discussion. Often, however, 
such interventions come later in the process than would be ideal, or 
mean that the i18n WG has to repeat the same information for each 
working group it interacts with.

It would be better if specification developers could access a checklist 
of best practices, which points to explanations, examples and rationales 
where developers need it. Developers would then be able to build this 
knowledge into their work from the earliest stages, and could thereby 
reduce rework needed when the i18n WG reviews their specification.

This document contains the beginnings of a checklist, and points to 
locations where you can find explanations, examples and rationales for 
recommendations made.  If there is no such other place, that extra 
information will be added to this document. It is still early days for 
this document, and it may also be used to develop ideas and organize them.

You may prefer to use Internationalization Techniques: Developing 
specifications 
<http://www.w3.org/International/techniques/developing-specs-dynamic> 
most of the time, since it uses JavasScript to help you more quickly see 
what's available and drill down to the information you need. (Where 
needed, it links to this or other documents.) There is also a 
non-dynamic version 
<http://www.w3.org/International/techniques/developing-specs> of the 
document available.
]]

If you have any comments or feedbck about this doc, please use 
<https://github.com/w3c/bp-i18n-specdev/issues>.

--
Received on Tuesday, 20 October 2015 10:45:19 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 18:14:58 UTC