Hi--

Per Rainer's suggestion, I've started a new thread for style guide update 
discussions.

I have finished incorporating the changes into Chapter 7, "Writing for an 
International Audience," in the OpenSolaris style guide. The changes are 
moderate.

If you have the time and the inclination, please review the changes, which are 
marked with change tracking. Any feedback is welcome. To access the chapter, go 
to:

http://opensolaris.org/os/community/documentation/reviews/

I'd appreciate receiving your feedback by October 30.

I'll summarize the changes here. If you would like to know more about why a 
specific change was made, feel free to ask. I'd be happy to provide details.

The updated chapter includes:

* New guidelines
* Clarification of existing guidelines
* More examples
* Bug fixes and consistency improvements

Some of the specific changes include the following:

* For accuracy, changed instances of "American English" to "U.S. English"

* Clarified guidelines about avoiding metaphors

* Added section on not using foreign terms

* Clarified guidelines about using the word "available"

* Rewrote section on using abbreviations and acronyms

* Added guideline about not using "Yes" or "No" in table data because they are 
problematic when translated into some languages

* Refined the index

Thanks so much for your help!

Alysson

-- 
Alysson Troffer
Technical Editor
Sun Microsystems, Inc.
 
 
This message posted from opensolaris.org

Reply via email to