Re: A tech editor seeks advice on which style guide to adopt

Subject: Re: A tech editor seeks advice on which style guide to adopt
From: quills -at- airmail -dot- net
To: Kat Kuvinka <katkuvinka -at- hotmail -dot- com>
Date: Wed, 23 Sep 2009 14:28:27 -0500

I still haven't found a good link to that document. Every link I find
leads to either a page no longer in use, or to a listing that has no
mention of the IBM Style Guide. It's become like a unicorn. Mythical,
unseen, and wonderous.

Kat Kuvinka wrote:
>
>
>
>
> I used to use MSTP, but thanks to some folks on this list I adopted the IBM Style Guide, free and easily available!
>
>
>
>
>> Hi All,
>>
>> Recently, in one of our doc team meetings, my manager asked me to come to a formal decision on which style guide we should adopt as the bible for our team. And as it goes with managers, I have to justify my decision.
>>
>> So far, the writers have been using MSTP (Microsoft Style for Technical Publications) for two reasons:
>>
>> 1. It is easily available.
>> 2. and free.
>>
>> I rather like Sun's Read Me First. The rationale appeals to me. The recommendations in their sound like recommendations and are less dictatorial than the MSTP.
>>
>> I would like to know which style guide would be best for web-based applications?
>>
>> Is MSTP really only for Windows-based apps or can it be adopted for web-based apps too?
>>
>> Which style guide (Sun's or MSTP) is likely to be adopted easily by the writers? That is not to say that I will take the path of least resistance if one or the other wins in merit versus ease of adoption.
>>
>> Kindly advise.
>>
>> Best always,
>>
>> Praneeta Paradkar
>>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices.
http://www.doctohelp.com/SuperPages/Webcasts/

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
A tech editor seeks advice on which style guide to adopt: From: praneeta p
RE: A tech editor seeks advice on which style guide to adopt: From: Kat Kuvinka

Previous by Author: Re: A little respect for "unvalidated"
Next by Author: Re: Follow-up to question about getting feedback from users
Previous by Thread: RE: A tech editor seeks advice on which style guide to adopt
Next by Thread: Re: A tech editor seeks advice on which style guide to adopt


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads