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: Organization of a Network Manual? From:Dave Swenson <Dave_Swenson -at- TRENDMICRO -dot- COM> Date:Tue, 30 Jun 1998 15:06:12 -0700
This sounds like a job for Visio!
So here's one idea:
Visio is a graphics program for creating, among other things, network
topologies. Use it to draw your network. Once you've got the entire
network logically represented in your diagram, you can use Visio's
drill-down property to provide details on the item being clicked.
Multiple layers are possible. This style would be good for on-line
(.html, .hlp, and/or Viso native files). And by the time you've finished
it, you'll have gathered and organized all the relevant network
information. Converting to printed matter, if necessary, would be pretty
straight forward. In this case the manual's organization would be
spatial, with the most salient network features serving as your headers
and the body text coming from the details you developed for the
drill-down information. When you're done, sell a version to the MIS
dept. They'd love to have just this sort of thing.
> -----Original Message-----
> From: Vanessa Wilburn [SMTP:vlwilbur -at- CPU -dot- COM]
> Sent: Tuesday, June 30, 1998 2:33 PM
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: Organization of a Network Manual?
>
> Hello,
>
> Perhaps someone has done something like this in the past...
>
> I am documenting the network at my company. Does anyone have examples
> of
> how this material should be organized? I am hoping to find an outline
> or at
> least top-level headings. I don't want to miss any key items that
> requires
> documentation.
>
> I will be covering items like the network structure, server names, DNS
> set-up/location, and firewall configuration.
>
> I searched through the archives, but didn't find any specific
> examples.
>
> Thank you,
> Vanessa Wilburn
>
> _______________________________________________________________
> Vanessa Wilburn vanessa -dot- wilburn -at- cpu -dot- com
> Computerized Processes Unlimited, Inc. http://www.cpu.com
> Metairie, Louisiana USA 504.889.2784
>
>
> &^~~~
> Send commands to listserv -at- listserv -dot- okstate -dot- edu (e.g., SIGNOFF
> TECHWR-L)
