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:Industry jargon OK in marketing docs? From:Julie Stickler <jstickler -at- gmail -dot- com> To:Technical Writing <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 11 Aug 2009 10:43:34 -0400
While I'm out of work I'm doing some contracting for previous
employers. Last week I formatted some marketing docs for the place
that I used to work a year ago. The text had already gone through
several edits (that I wasn't involved in) so since I was mostly hired
to format it in InDesign and generate a PDF, I only fixed one glaring
error, changing "contractor spend" to "contractor spending."
Today I recieved an e-mail asking for the following "Change “spending”
back to “spend” for phrases like “contractor spend.” This is industry
jargon."
Arggghhhh! I was always taught to remove jargon from my docs. But
then I have done mostly software manuals and help, I haven't had much
experience writing marketing documents. One the one hand I'm thinking
that since I'm contracting, the customer is always right. If that's
what they want, that's what I should give them. On the other hand,
gramatically incorrect jargon makes me cringe.
So I ask you, TECH-Wrlers, do you include industry jargon in your
marketing docs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-