W3C home > Mailing lists > Public > wai-eo-editors@w3.org > June 2017

Re: [style guide] abbreviations and acronyms - general best practice

From: Shawn Henry <shawn@w3.org>
Date: Fri, 30 Jun 2017 12:46:16 -0500
To: wai-eo-editors@w3.org
Message-ID: <c4bf04bc-b83b-e78f-f21b-732ba507d74c@w3.org>
On 6/30/2017 12:17 PM, Bakken, Brent wrote:
> I agree with this approach in a general sense. I would like to caution that not all participants are up to speed on general writing best practices as you are, because they may have never written a book, journal, or professional web content before.

Point well taken, Brent! Thanks for the reminder.

I studied technical writing in college and worked as a tech writer and editor for a few years.
/me shakes self and remembers to put herself in audiences' shoes!

> I like the idea of having this stuff somewhere, just not the main focus of the style guide. Keep main focus specific to WAI web site content writing.

+1

~Shawn

> 
> *__*
> 
> Brent A. Bakken
> Director, Accessibility Strategy & Education Services
> Pearson
> 
> 512 202 1087
> brent.bakken@pearson.com <mailto:brent.bakken@pearson.com>
> 
> Learn more at pearson.com <http://pearson.com>
> Pearson
> 
> 
> 
> On Fri, Jun 30, 2017 at 11:52 AM, Shawn Henry <shawn@w3.org <mailto:shawn@w3.org>> wrote:
> 
>     I made these suggested revisions:
>     https://www.w3.org/WAI/EO/wiki/index.php?title=Style&diff=20359&oldid=20357 <https://www.w3.org/WAI/EO/wiki/index.php?title=Style&diff=20359&oldid=20357>
> 
>     However, I'm not convinced that we even want this point in this Style Guide at all. It is general best practice, and perhaps it's more clutter than helpful?
> 
>     One idea is that we have a section for reminders of general best practice that includes points like this, and that section is separate so it's easier for people to focus on the more specific issues?
> 
>     On 6/30/2017 11:40 AM, Shawn Henry wrote:
> 
>         I think that we want this Style Guide to be as short and easy-to-consume as feasible. If so, we'll want to be thoughtful about what we include and what not to clutter it with. For example, maybe we don't need to include obvious things, and certainly we don't want to recreate general writing best practices.
> 
> 
> 
>     Thoughts?
> 
>     ~Shawn
> 
> 
Received on Friday, 30 June 2017 17:46:47 UTC

This archive was generated by hypermail 2.4.0 : Tuesday, 23 June 2020 20:41:51 UTC