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:Re: Crispy around the edges From:jposada -at- comcast -dot- net To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 28 Jun 2004 18:23:51 +0000
> John, I thought of this when I initially saw your post last week but
> then I became busy with my project and forgot. I would write something
> like: Administration (aka Admin) and make Admin a link so that it is
> easily found.
> I usually do include jargon, as I showed above. I guess I feel that you
> never know what a user is going to look for when entering information
> for their search.
To what degree do you "search out" jargon to include it. In documentation, I avoid using jargon. That means I would have to consider each appropriate term and determine if there is a jargon form of it, then figure out how to include it.
It's one thing to have used a jargon term, then cross-referenced it to the proper form, (admin, see administration), but do you actually make an effort to shoehorn jargon terms into a document just so they might be found?
An index might be a different matter, but who includes the document index in a help file?
COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. http://www.componentone.com/doctohelp .
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- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.