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:How evil is copy-and-paste? From:Craig Hadden <craig_john_hadden -at- yahoo -dot- com -dot- au> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 18 May 2005 16:15:59 +1000 (EST)
Recently I updated a user guide in which the original
author thought it was a really smart idea to use
copy-and-paste to duplicate a _lot_ of content
(instead of using cross-references, would you
believe). Then today I read a 10-sentence software
change-request in which literally _half_ of the
sentences each began with the same 21 words! ("The
amount of any Deduction processed through payroll with
a Type X should be added to the figure in the...")
That's a quick (and dirty) way to produce heaps of
"documentation". But it makes an awful experience for
readers, I reckon. (Not to mention making
documentation maintenance a nightmare.)
I'm beginning to think of various rules of thumb about
copy-and-paste, such as:
* Paste no more than 3 words at a time.
* If you paste the same item more than, say, twice,
think again about what you're doing.
I'm not suggesting these should be hard-and-fast
rules, just "guidelines". (Picture the way Geoffrey
Rush and Johnny Depp said the word in Pirates of the
Caribbean, with finger-quotes and an "arrr, Jim-lad"
accent.) As Geoff Hart put it so eloquently, "the
thing to remember about "rules of thumb" is that
thumbs bend when necessary".
Does anybody else have any suggestions for rules of
thumb about (avoiding) duplicating content?
Thanks,
Craig
===== My e-mail address is:
===== craigh(at)attachesoftware(dot)com
===== (I may not see messages sent to my Yahoo address)
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
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.
