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: Wording too dense? OK? From:"Susan W Gallagher" <susanwg -at- gmail -dot- com> To:"TECHWR-L Administrator" <admin -at- techwr-l -dot- com> Date:Wed, 27 Jun 2007 11:37:16 -0700
While the instructions may be perfectly comprehensible to your SME and to
many members of the target audience who are already familiar with the
application, I'd wager there'll be some who'll look at that procedure and
call tech support immediately. <g> And even if 100% of the target audience
did understand the instructions, have you no doc standards to enforce? If it
were me, I'd insist on complete sentences at the very least - there is a
paucity of verbs in your sample text. Were I you, I would ask to watch the
procedure being performed and be prepared to take copious notes.
MOO, YMMV, HTH
-Sue Gallagher
On 6/27/07, TECHWR-L Administrator <admin -at- techwr-l -dot- com> wrote:
>
>
> Forwarded anonymously on request. Please respond on list--
> no responses will be privately forwarded. TECHWR-L Admin
> &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
>
> I need help with the following passage. My source has a bit of the
> mentality "the passage is fine because anyone who's reading the manual
> will know everything already, because I wrote it and *I* know everything
> already and so will anyone reading my text." My source does not welcome
> questions and clarifications that I believe are necessary. I need your
> perspectives.
>
> Here's a brief sample:
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
