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:Pro TechWriter <pro -dot- techwriter -at- gmail -dot- com> To:praneeta p <praneeta_paradkar -at- yahoo -dot- com> Date:Wed, 23 Sep 2009 10:19:43 -0500
Hi:
For Web-based applications, I prefer Read Me First, supplemented with the
Chicago Manual of Style online. I've used the MSTP for Web applications, but
it is kind of like forcing that square peg in the round hole. It doesn't
always quite fit.
Good luck!
PT
On Wed, Sep 23, 2009 at 4:29 AM, praneeta p <praneeta_paradkar -at- yahoo -dot- com>wrote:
> 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
>
>
>
>
> Add whatever you love to the Yahoo! India homepage. Try now!
>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 pro -dot- techwriter -at- gmail -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/pro.techwriter%40gmail.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
>
>
--
“You can only become truly accomplished at something you love....Pursue the
things you love doing, and then do them so well that people can't take their
eyes off you.”
- Dr. Maya Angelou
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-