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.
> Perhaps you could clarify the sentence beginning, "aggressively non-
> technical ..."?
>
> In my experience, vagueness is more likely to originate with engineers or
> software developers who are busy doing their primary job, which is not
> typically writing instructions or user assistance.
>
> As a non-technical technical writer who does an excellent job documenting
> software and hardware, I also take exception to the whole tenor of your
> comment. A so-called technical writer who would insert an ambiguous phrase
> is simply not in tune with the requirements of the job. It doesn't matter
> if they're "technical" or "non-technical".
I suspect that we mean different things by the term "non-technical." If you don't insert such ambiguous phrases, then you're not the kind of non-technical tech writer I was thinking of. :-)
I've seen plenty of documentation like the procedure I described, and I've met (and occasionally worked with) the authors of such documentation. They typically don't care to understand the products and technology they're documenting, preferring to simply edit and make "look pretty" the information they get from SMEs and other sources. And they often defend their ignorance by saying it makes them more in tune with novice users.
Maybe I shouldn't say "non-technical," which suggests anyone who can't program, hasn't mastered a body of technical knowledge, etc., but I'm not sure what a better term would be. I said _aggressively_ non-technical to suggest someone who not only doesn't know the technology but is opposed to learning about it. Would anti-technical be better?
Richard
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-