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.
Subject:Re: within vs. in From:Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Fri, 18 Jan 2008 09:53:34 +1100
>> From: Gause_Brian -at- emc -dot- com
>> I agree with Janice. You are the writer. You have final say on words.
> I thought the customer-project sponsor-document owner had final say in how
> the documentation is presented. My experience is that writers can state
> what they think is best, but the final product and its content is determined
> by the product's owner who is not usually the writer when an SME is
> If the OP is the owner of the document, then she would have final say on
> words; otherwise, she does not. Although, support for an argument to use
> "in" rather than "within" can help her make her case about the convention to
I suppose it depends on where you work. I wouldn't
use the word "own" but most of the tech companies with
which I've been involved defer to the SME for technical
content but are paying the writer for writing expertise
so the SME is responsible for making sure that the content
is technically accurate and the writer is responsible for
writing decisions. It's fairly standard for tech review
cover letters to indicate that the tech review should cover
technical content rather than the writing itself and that
decisions on grammar and wording remain with the writer
unless the suggestion is intended for technical clarity.
YMMV, of course.
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-