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.
Re: The cost of inaccurate technical documentation
Subject:Re: The cost of inaccurate technical documentation From:"Damien Braniff" <Damien -dot- Braniff -at- asg -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 29 Mar 2007 08:25:05 +0100
Gene said <Legal documents are intended to take simple concepts
(justice, fair play, keeping one's word, doing what's right and
ethical), make them so complicated that you can't possibly understand
them> and I have to agree. However, there is hope.
A few years ago now at a conference one of the sessions was on 'plain
English law' and the speaker was a solicitor (UK!) who was part of a
group campaigning for simplicity in legal docs (at least to make them as
simple as possible!). He gave several examples including one which was a
contract for house buyers/sellers (I remember this one as we were buying
at the time!). The 5/6 page legal doc was reduced to under three pages
all unnecessary legal jargon removed. So the 'party of the first part'
etc became buyer, seller, etc.
The result was documents that were, while still complicated in some
cases, readable and understandable by a non-legal person. I don't know
how far the movement's progressed but it was a start.
Damien Braniff
Sr. Technical Writer
damienb -at- asg -dot- com
Waterfront Plaza
8, Lagan Bank Road
Belfast, N. Ireland BT1 3LR
Tel: +44 (0) 28.9072.3124
Fax: +44 (0) 28.9072.3324
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. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-