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.
Our documents are integrated into the product
structure in the same engineering database as
the design drawings. We also enter "Used In"
and "Next Assembly" part number data into the
document control releases. This enables us to
display the structure of the entire product or any
subassembly (such as the document pack) as
either a bill of materials/list or a graphic drawing
tree on demand, as well as do reverse lookups
to display which products documents are used
This system would also enable me to outline
the internal structure of an individual document
by assigning the document an orderable part
number, assigning non-orderable part numbers
to its chapters, illustrations, etc., and treating the
document as an assembly so I can generate BOMs
or trees for it, but I've never had the need to break
down a single document to that level of detail (if I
did this I would have a "knowledge base," except
that it would be accessed through the document
control system rather than a user-pretty web portal).
----- Original Message -----
From: "Hemstreet, Deborah" <DHemstreet -at- kaydon -dot- com>
To: "techwr-l List" <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Monday, May 19, 2008 6:07 AM
Subject: Document Mapping
> Hi All,
> I have a question: are there any tools out there to help someone do a
> graphical representation of documentation?
> We have some incredibly complex procedures with many supporting
> documents. My supervisor would like (and I think it's a nice idea), a
> graphical representation of how all of these documents relate to each
> other, as well as to the company as a whole. (with references to the doc
> numbers). Color codes could indicate the types of documents (policy vs
> procedure vs work instructions)
> This way, someone can, at a glance, see what is involved via charting
> and color coding what documents are needed to do something.
> Any thoughts or ideas?
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-