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: Tweaking English in manuals and localisation From:John Cornellier <tw -at- cornellier -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 12 Apr 2002 10:44:25 +0200
Jennifer O'Neill wrote:
> How tolerant should one be of inelegant English?
Many things go into making good documentation. Accuracy, timeliness, usability, and others. The quality of the
English is just one of many elements and has to share development time with others. As technical writers we are
liable to allocate disproportionate resources to stylistic elements of a document.
It's not whether clunky English is OK. It's not. But you can't do everything and you have to set priorities. If
there aren't resources to have technical accuracy AND elegant English, then unfortunately the clunky English will
have to stand.
That said, once you get a system in place where the documents are usable and technically correct, then you could
try devising a project to update the English. Cost it up, go to the person who signs the cheques and explain the
problem. Tell her about the costs and benefits, and see if she goes for it. It's a business decision.
> How do you persuade tech writers to consentrate
> on what must change (eg, techncial content) and not fiddle
Communication. Common objectives. Carrots not sticks. Talk to all parties, agree on a system that works, and ask
everybody to toe the line.
It's understandable that a person hired as a "writer" is frustrated by having to update parameters or format docs
all day. However, he can be kept motivated if given _new_ projects to write and "own".
John Cornellier
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
