Re: Living documents?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Jim Jones wrote:
Is 'living' document a regular way of describing
them? Anyway, I like this nomenclature and I'd
guess that an immutable document, one that is not
modified too much over the years, would still be
a 'living' document. A dead one I guess would be
one that is no longer used for any kind of reference.
Here's my take on the terminology based on how my job works. Your
situation may be different.
To create my manuals, I use "living" source files that are shared
between (linked into) multiple manuals. These source files live in a
central location on our server, and they change whenever new information
becomes available, whenever corrections are necessary, or whenever I
think of a better way to say or illustrate something. Changes made to
the living source files may take months to show up in my released
manuals, depending on how important the changes are or on where a
particular manual falls in the queue for being updated.
The manuals that I release are not living, no matter how often they are
revised or how recently they were released. A released manual is a
static snapshot of how the living source files looked at the time that
the manual was released. A released version of one of my manuals can be
"current," but it is not living because it may not change after I
release it. Any updates require a new part number or a new revision
number.
If a manual is made obsolete without a new one replacing it, that's when
the manual is officially "dead" or "obsolete." Some people may still
choose to or need to use it, but we no longer update it.
Donna
-------------------
Donna L. Jones
Technical Writer II
Zebra Technologies
Vernon Hills, IL
- CONFIDENTIAL-
This email and any files transmitted with it are confidential, and may
also be legally privileged. If you are not the intended recipient, you may
not review, use, copy, or distribute this message. If you receive this email
in error, please notify the sender immediately by reply email and then
delete this email.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that
easy. Watch the demo at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as eddy -dot- skau -at- gmail -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/eddy.skau%40gmail.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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/archive%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
References:
RE: Living documents?: From: Jones, Donna
Previous by Author:
Re: Non-TW supervisor
Next by Author:
Re: Documentation Architect...is there really such a creature?
Previous by Thread:
RE: Living documents?
Next by Thread:
RE: Living documents?
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads