Re: Looking for classes in indexing

Subject: Re: Looking for classes in indexing
From: Lin Sims <ljsims -dot- ml -at- gmail -dot- com>
To: David Artman <david -at- davidartman -dot- com>
Date: Mon, 30 Jul 2018 14:05:40 -0400

Oh, I LIKE that idea. There are no processes in place for that sort of
thing, and generally we only have one or two reviewers, but this could be
very, very useful, and it's quite clever.

On Mon, Jul 30, 2018 at 1:39 PM, David Artman <david -at- davidartman -dot- com> wrote:

> Aside from 'spotting gotchas' that others have mentioned, I've put
> indexing to very good use in the past for *targeted reviews of changes*.
>
> For instance, if a "User Story 123456" resulted in my changing 15
> topics, then I would add an index entry like so:
> <indexterm>!User Story<indexterm>123456</indexterm></indexterm>
>
> Resulting in:
> !User Story
> 123456 25, 28, 30-32, 50, 256
>
> Alternately, if I had another driver of change, like a specific
> developer's design document or a feature name, Id use:
> <indexterm>!Annie Devvie</indexterm>
> or:
> <indexterm>!Feature<indexterm>Fooing bars for
> widgets</indexterm></indexterm>
>
> The result being that I could put out an Adobe Shared Review PDF for a
> whole team, for weeks of development, and they could quickly jump
> through the additions and changes using all (and only) the index entries
> that pertain to them.
>
> Then just comment out the 'review-tracking' index entries after approval
> (and remove any change highlighting--the index helps *me* find those
> later!) and they no longer appear... BUT, I still have, in the working,
> source files themselves, searchable unique strings if I ever have to
> lookup what caused me to change what, when.
>
> Kinda powerful, if you don't already have other significant
> change-tracking controls (CMS history, dev-item-tracking app, etc). And
> even if you DO, you can 'audit' in just your file stack, using search:
> no need for complex queries in other tools and correlating their results
> to your file stack. One Stop Shop, so to speak. :-)
>
> HTH;
> David
>
>
> -------- Original Message --------
> From: "Wright, Lynne" <Lynne -dot- Wright -at- Kronos -dot- com>
> Date: Thu, July 26, 2018 5:12 pm
>
> Can you elaborate on how indexing is a good way to review your work?
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as ljsims -dot- ml -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>



--
Lin Sims
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

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

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
RE: Looking for classes in indexing: From: David Artman

Previous by Author: Re: Looking for classes in indexing
Next by Author: Model for Creating/Tracking Document Addenda/Errata
Previous by Thread: RE: Looking for classes in indexing
Next by Thread: RE: callout colors - for black-background screenshots ?


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

Sponsored Ads


Sponsored Ads