Re: Style Guides for Tech Docs

Subject: Re: Style Guides for Tech Docs
From: David Neeley <dbneeley -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 22 Dec 2004 14:45:58 -0600


First, I agree completely with what Susan has written.

I should add that in some companies, style guides are set not only for
documentation but for marketing communications, too--to be sure that
everything that is written to be customer-facing has a unified
treatment.

Thus, if you are new to a company and you are unaware of a style guide
being used for docs, you might also check with Marketing to see
whether they have any such guides. On the off-chance they do, you may
save yourself some rather painful editing time later...and the
corporate image types will appreciate your initiative.

David


On Wed, 22 Dec 2004 14:52:01 -0500, Susan W. Gallagher
<sgallagher5 -at- cox -dot- net> wrote:
>
> Well, pretty much the standard answer -- "It depends" --
> applies here. <g>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!

RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



References:
Re: Style Guides for Tech Docs: From: Susan W . Gallagher

Previous by Author: Re:Shyness; was: Re: Seeking counsel
Next by Author: Re: Outsourcing Tech Pubs
Previous by Thread: Re: Style Guides for Tech Docs
Next by Thread: question for canadians


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


Sponsored Ads