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.
Anita asked about Jargon.
How big of a client are the people who want you to add the kind of jargon you're talking about? If they're your company's primary customer, for political reasons you might want to consider including the jargon. In general, though, you should avoid this. It WILL alienate other clients. Your best bet is to include index and glossary entries such as
degrowth - see removing equipment
That's assuming the jargon your users were talking about is not industry standard. If it IS industry standard, then you should definitely include the jargon. There's no reason not to, and leaving it out will only confuse your users. For example, when I was documenting 3D animation software, I didn't shy away from using terms like "tweening" and "keying" because those were industry terms that anyone in the industry should know. To be safe, I also included those terms in a glossary for the newbies, so you might think about doing that.
If you're not sure about what the standard industry terms are, check out a glossary for the industry. You can find them on web sites, in books, journals, etc. If you know for a fact that the client is using non-standard terms, then they need to learn to deal with that difference. :-) To be nice, you might think about creating a glossary that includes standard and non-standard terms.
Promote your group and strengthen ties to your members with email -at- yourgroup -dot- org by Everyone.net http://www.everyone.net/?btn=tag
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
Free copy of ARTS PDF Tools when you register for the PDF
Conference by May 15. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
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.