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.
Subject:RE: How to write for information reuse? From:Kay Robart <kay -dot- robart -at- integratedconcepts -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 11 Feb 2000 14:06:25 -0600
I haven't actually done this yet, but I have gone to a few talks on it
because
of curiosity and interest. The main thing suggested is that you plan very
carefully the types of information you want in the database, their levels,
the tagging for those types, and work out the wording with all available
authors, because
they have to be able to agree that something is the "golden" paragraph.
As soon as you change the information, you defeat the purpose.
I just saw a talk on this by Joanne Hackos, and she is working on a book
about
it that should be available soon.
Kay Robart
> What are the Do's and Dont's of writing information that should be
> reuseable
> in a databased Document Management System?
>
> We are currently setting up a DMS with FrameMaker+SGML and a Chrystal
> Astoria document database. One of the main reasons for this is that we
> want
> to be able to reuse parts of documents, thus saving time & money on
> storage,
> maintenance, translation and review of these parts, and improving overall
> documentation consistency.
>
>
>