Re: Crispy around the edges

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?

--
John Posada
Senior Technical Writer




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

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.



Follow-Ups:

Previous by Author: Re: Crispy around the edges
Next by Author: Re: Crispy around the edges
Previous by Thread: Re: Crispy around the edges
Next by Thread: Re: Crispy around the edges


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads