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.
Chantel and Gene have both raised an issue I should have clarified: these items are also indexed under other major nouns. They appear under the nouns Gene suggests, for example, and under Thingie 5000 as Chantel suggests. However, the terms beginning with "power" are also terms commonly in use, so I want to include these four specific terms and thus am wondering about possible ways to group them.
--Nancy
May 23, 2011 03:09:46 PM, brathwaitec -at- castupgrade -dot- com wrote:
Nancy,
I agree that they could be kept separate.
But you could cross reference at least two of them in other places and
combine them there. For example
Thingie 5000
power cable, see power cable for Thingie 5000
power supplies, see power supplies accepted by Thingie 5000
I'm assuming that the Thingie 5000 is just one of several pieces of
equipment that you are documenting and that the power on/off button and
power supply connector might be connected to other subcomponents of a
larger system and not the Thingie 5000. If all of these are related to
the Thingie 5000 and the Thingie 5000 is not the only piece of equipment
documented in your manual - it would seem to make sense to group them
under the Thingie 5000 header and also cross reference them.
Chantel
On 5/23/2011 2:51 PM, Nancy Allison wrote:
> Currently, these items appear in the index of my manual:
>
> power cable for Thingie 5000 2-4
> power On/Off button, location of 2-7
> power supplies accepted by Thingie 5000 2-8
> power supply connector, location of, 2-9
>
> I think that these four entries are so different that there is no logically acceptable way to combine them, even though they all begin with the same word.
> For example, "power cable" is a two-word, distinct noun, while "power supply connector" is a distinct, three-word noun. I don't think those two can acceptably be combined as
>
> power
> cable for bell, 2-4
> supply connector, location of
>
> I think all four have to stand alone. Do you agree, or would you handle them differently?
>
> --Nancy
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create and publish documentation through multiple channels with Doc-To-Help.
> Choose your authoring formats and get any output you may need. Try
> Doc-To-Help, now with MS SharePoint integration, free for 30-days.
>http://www.doctohelp.com
>
> ---
> You are currently subscribed to TECHWR-L as brathwaitec -at- castupgrade -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/brathwaitec%40castupgrade.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as maker -at- verizon -dot- net -dot-
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as admin -at- inktopia -dot- net -dot-
