RE: Documentation Sanity Check

Subject: RE: Documentation Sanity Check
From: MList -at- chrysalis-its -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 9 Apr 2003 09:53:35 -0400


John Posada [mailto:JPosada -at- book -dot- com] wondered:

> So, over the last 2-3 days, I've been going back through all
> my Framemaker
> tables and reimporting the data into an Excel table, then
> sorting, grouping,
> etc.
>
> What I found was that a substantial amount of data is either
> transposed,
> obsolete, missing, applied incorrectly, or not applied
> uniformly across the
> documentation. I can understand HOW it happens, you're
> rushed, you're giving
> erroneous information, you make stupid errors, names change in the
> application being written about but you either don't know,
> aren't told,
> don't realize the significance until too late.

[snip]
> So...my question. How many of you take the data from your
> documentation,
> massage it in a different application than what it was
> authored in, and if
> you do, what have you found?

My answer to the above, and to the other questions that I
snipped for space is... no, I don't.

I'm not really clear on how you are doing it, what forms
this information takes, how you are chunking and categorizing
it to fit into the everything is a table-entry format, etc.

I have some data in tables and lists (stuff like supported
algorithms, compatibility matrices, viewable/settable system
capabilities and policies... But much of it is not in that
form. Much of it is procedures and explanations of why you'd
want to perform a given procedure, where it fits into the
greater scheme of things, what the options are, and why... and
like that.

It might be worth my while to do what you're suggesting, but
I don't quite have a handle on it, from your brief description.
Actually, it looked like a recognition description -- if you
recognize this, meaning that you are already doing it, say yes.

For those of us who don't/aren't... say on, sir! Say on! :-)

/kevin


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Purchase RoboHelp X3 in April and receive a $100 mail-in
rebate, plus FREE RoboScreenCapture and WebHelp Merge Module.
Order here: http://www.ehelp.com/products/robohelp/


Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
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.



Previous by Author: RE: YOU are responsible, even when YOU are not to blame
Next by Author: RE: YOU are responsible, even when YOU are not to blame
Previous by Thread: Re: Documentation Sanity Check
Next by Thread: Re: Documentation Sanity Check


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

Sponsored Ads


Sponsored Ads