icons vs. buttons?

[Lauren]

I call Microsoft's Style Guide, "MSG," but I think it's usually referred to
as MSTP.  I don't care for MSG, the food additive and I don't care for MSG,
the style guide.  MSTP (I guess I'll refer to it like wiki says we should)
does have many rules that are consistent with rules that I prefer, but it
also has many rules that contradict my preference.  Like, one of its
examples, "On the *File* menu, click *Open*."  I prefer to "select" when
there is a drop-down list, even a list from a toolbar.  So I would "Select
*Open* from the *File* menu."  The way I see it, Microsoft is no more an
authority of documentation style than it is an authority of documentation
software.  

Microsoft doesn't really come up with anything new but it does use or mimic
tools and rules that are easiest for the general population to grasp.  That
is why its software is "user-friendly."  More people can "use" it, so it is
"friendly."  I think that its style guide follows the same path.  I have
found errors and inconsistencies in MSTP, although it's been a year since I
have used the guide, so I don't remember the errors.  Some of the errors
involved examples between "correct" and "incorrect" that matched.

Personally, I wouldn't rely on MSTP as an authority, but it can be a guide
and perhaps help support arguments.  I once argued about the use of a comma
before the last list item.  I said that it is necessary for clarity and some
companies, like HP when I was there, require it for legal reasons, but the
company style guide said to leave it out.  I mentioned that the style guide
was based on MSTP and I won the argument but not the comma.  MSTP supported
my rule, but the resident tech writer did not.

Ultimately, if a company uses a style guide, then the writer should use that
guide, regardless of personal preference.

Lauren
 

> -----Original Message-----
> From: techwr-l-bounces+lt34=csus.edu at lists.techwr-l.com 
> [mailto:techwr-l-bounces+lt34=csus.edu at lists.techwr-l.com] On 
> Behalf Of Keith Hansen
> Sent: Wednesday, August 01, 2007 9:13 AM
> To: Yves JEAUROND
> Cc: techwr-l at lists.techwr-l.com
> Subject: RE: icons vs. buttons?
> 
> <<have you checked your copy of the _Microsoft Manual of Style for
> Technical Publications_? 
> It recommends: "Click OK.">>
>  
> I did check it. But I wondered if everyone else agrees the MS 
> Manual is
> OK regarding OK!  
>  
> Keith
> ________________________________
> 
> From: Yves JEAUROND [mailto:jingting at rogers.com] 
> Sent: Wednesday, August 01, 2007 9:09 AM
> To: Keith Hansen
> Cc: techwr-l at lists.techwr-l.com
> Subject: RE: icons vs. buttons?
> 
> 
> Keith Hansen:
>  
> Conscensus-nonsensus; :-)
> have you checked your copy of the _Microsoft Manual of Style for
> Technical Publications_?
>  
> It recommends: "Click OK."
>  
> Regards,
>  
> YJ 
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> Create HTML or Microsoft Word content and convert to Help 
> file formats or 
> printed documentation. Features include support for Windows 
> Vista & 2007 
> Microsoft Office, team authoring, plus more.
> http://www.DocToHelp.com/TechwrlList
> 
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
> 
> ---
> You are currently subscribed to TECHWR-L as lt34 at csus.edu.
> 
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe at lists.techwr-l.com
> or visit 
> http://lists.techwr-l.com/mailman/options/techwr-l/lt34%40csus.edu
> 
> 
> To subscribe, send a blank email to techwr-l-join at lists.techwr-l.com
> 
> Send administrative questions to admin at techwr-l.com. Visit
> http://www.techwr-l.com/ for more resources and info.