TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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:praneeta p <praneeta_paradkar -at- yahoo -dot- com> To:Kat Kuvinka <katkuvinka -at- hotmail -dot- com>, quills -at- airmail -dot- net Date:Thu, 24 Sep 2009 03:02:42 +0530 (IST)
The version I have on my desktop is most probably outdated. I'll have to check.
Now, as for the decision with the style guide: I am now armed with more options than what I started out with.
I have to evaluate these four:
IBM Style Guide
Apple
Sun's
MSTP
I am leaving Chicago Manual and Ap out of the race as I want something specific to information technology.
I'll keep you posted. Will probably proceed from here to do a SWOT analysis of each style guide.
I promise to share my experience of how it goes.
Till then, thanks for all your inputs. Appreciated.
Back to researching and more searching!
--- On Thu, 24/9/09, quills -at- airmail -dot- net <quills -at- airmail -dot- net> wrote:
From: quills -at- airmail -dot- net <quills -at- airmail -dot- net>
Subject: Re: A tech editor seeks advice on which style guide to adopt
To: "Kat Kuvinka" <katkuvinka -at- hotmail -dot- com>
Cc: praneeta_paradkar -at- yahoo -dot- com, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thursday, 24 September, 2009, 12:58 AM
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
>>
>
Yahoo! India has a new look. Take a sneak peek http://in.yahoo.com/trynew
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-