Question about book not keeping to Writing dept. style guide

Subject: Question about book not keeping to Writing dept. style guide
From: "Caroline Tabach" <caroline -dot- tabach -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Mon, 18 Dec 2006 12:12:42 +0200

Our writing dept has a style guide made over the years by our managers
and added to by various writers (i.e. although I do not have specific
sources to say why one usage is better than another, this is how all
our books are written).

When I was on maternity leave one of the user guides was outsourced
and while they did use our FrameMaker template, they did not use our
style guide.
As a result many things appear differently in this guide than in our
other guides.
This guide is not a "one-off" guide but for a product being updated.

The types of things that are different here are:
*a different table style is used
*There are table titles (which we do not have in our other guides)
*A lot of quotations marks are used while our style guide calls for
using italics instead of quotation marks as much as possible.
*The way tables, and dialog boxe are introduced is different.

Except for the quotation marks Vs italics I do not think anything here
is wrong usage, but they just make this book different from all of our
other books.

The question is, should I ask one of the writers here to go through
the book and make the appropriate changes so it conforms to our style
guide. I am hesitant because quite a lot of work is involved
especially replacing all of the quotation marks used.


Caroline Tabach
e-mail: caroline -dot- tabach -at- gmail -dot- com

WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!

Create HTML or Microsoft Word content and convert to Help file formats or printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output.

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

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 for more resources and info.


Previous by Author: RE: Techwr-l Flashback
Next by Author: RE: Why I like this list but not OT
Previous by Thread: Sorting Tables in RoboHelp X5
Next by Thread: RE: Question about book not keeping to Writing dept. style guide

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

Sponsored Ads