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.
> -----Original Message-----
> From: Ann Waterhouse
> Sent: November-08-11 4:59 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Automation vs. User-created
> First of all thanks to everyone who helped me with my search for
> documentation automation software. It has led me to ask this question
> for all the techwr-l's out there...
> What are the advantages and disadvantages to having documentation
> completely automated as opposed to user created documentation?
> Let me give you an example.... A totally automated document assembly
> system that takes pre-formatted and stored snippets of information to
> make a document is rigid and leaves little room for 'on-the-fly'
> customization while picking and choosing snippets allows the writer to
> customize the order of information and to easily omit information that
> may not be needed.
> Your thoughts??
First, is 'on-the-fly' customization needed?
What would be the added value to the person paying the bills?
Second, who makes the snippets?
Whoever does that should ensure that each is self-contained
and has whatever keywords are needed, in order to call it
out of the database when needed... but not when it's not
The real hero in that scenario will be the database designer,
who will specify what the contents (snippets) must contain,
so that the scheme can actually work.
I think that the options are:
a) a big flop that doesn't do what was hoped, because the
necessary prep-work was glossed over, or
b) a really, really expensive success, because you (or the
hero) took the time to really, really plan and execute the
design and creation of the database.
The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
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 archive -at- web -dot- techwr-l -dot- com -dot-