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.
> I am developing very innovative (I really doubt if anyone has done this
> before) software documentation for a larger scale web-based systems.
> Basically, I am creating data flow diagrams to then create web sites that
> show the systems at a high level.
Richard...you are right, what you are describing sounds very useful, but it has been done before.
My current infrastucture architect does it for our QA infrasture (about 700 IP addresses) from the highest level network component down through about 5 or more layers, each layer becoming more granular and specific.
For example, the highest level has the domains. Click a domain and you get the diagram of the items in the domain (router, switch, host, etc.) Click a host and you get the IP and information such as memory, cpu's, disks, etc. Click the CPU and you get performance data for the CPU, etc.
Our QA testers use it to look at the characteristics of the component to determine how it's acting when subjected to QA tests. What make's his interesting (though I doubt unique) is that it is dynamic to the actual system. When a device is added, removed, or modified, everywhere that device is shown is updated automatically. I don't know how he does half the stuff he does, but it's pretty cool. Also, gotta keep in mind that part of it (collecting network performance data) is what we do. Look up EMC Smarts (http://www.emc.com/products/software/smarts/smarts_family/index.jsp)
I also did it at a previous gig where I documented the flow of order data thoughout a book reseller's system (B&N.com), starting at a high level (let's say, SAP) and getting more and more grannular as you clicked down through components. it was done in Visio, the high-level, when printed, was about 7 foot by 10 foot, and by the time you were done clicking through, you had a software or hardware component with a link to the documntation PDF for the section where that element was documented.
I'm sure we'd love to hear how you are doing what you are, but not if every paragraph is rife with "unique"....it's not, though it does sound interesting.
Keep in mind that a normal enterprise network continualy changes. Unless you have a way of dynamically updating your diagrams, you'll have a snapshot, but which will degrade as time goes on.
John Posada
Senior Technical Writer
"They say everyone needs goals. Mine is to live forever.
So far, so good."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
