Re: Developing Online Docs

Subject: Re: Developing Online Docs
From: Rick Sapir <rick_sapir -at- GILBARCO -dot- COM>
Date: Mon, 25 Mar 1996 12:46:38 -0800

This is a Mime message, which your current mail reader
may not understand. Parts of the message will appear as
text. To process the remainder, you will need to use a Mime
compatible mail reader. Contact your vendor for details.

Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Content-Description: cc:Mail note part

Wow! Lots of interesting ideas and questions. Let me take a stab
at a few.

>Subject: Developing Online Docs
>From: Beryl Doane <BDoane -at- engpo -dot- msmailgw -dot- intermec -dot- com> at ~GATEWAY
>Date: 3/22/96 10:24 AM


>Technical support wants to put our manuals on the Web with HTML.
>For optimal usability, we need to redesign and rewrite the
>paper docs. It is also important for Tech Pubs to maintain
>version and content control.

Is this really for on-line documentation, or electronic distribution?
If you're going to the web (or other on-line service such as a BBS)
primarily for easier, quicker, and cheaper distribution, I'd suggest
using Acrobat. If your users, are going to access your docs, then print
them out and bring the printout with them on a service call, it may
be important to maintain your formatting and doucment appearance.

>The field technicians are interested in having maintenance
>manuals on CD-ROM or on the Web so that they do not have to
>carry 40 pounds of docs to a customer site.

CDs are nice, but they present some of the same problems as paper
documents do: they're not very dynamic. I guess it really depends on
how quickly you update your docs.

Rick Sapir Gilbarco, Inc.
Technical Communicator Greensboro, NC
Rick_Sapir -at- gilbarco -dot- com
DISCLAIMER: Speaking for no one but myself.

-----=====[ THIS SPACE FOR RENT ]=====-----
Content-Type: text/plain; charset=US-ASCII; name="RFC822 message headers"
Content-Transfer-Encoding: 7bit
Content-Description: cc:Mail note part

Received: from by with SMTP
(IMA Internet Exchange 1.04b) id 153216c0; Fri, 22 Mar 96 13:53:48 -0800
Received: from by with SMTP id AA26885
(InterLock SMTP Gateway 3.0); Fri, 22 Mar 1996 13:54:23 -0500
Received: from by id aa25501;
22 Mar 96 13:25 CDT
release 1.8b) with spool id 54809 for TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU;
Fri, 22 Mar 1996 12:24:35 -0600
Received: by (4.1/3.1.090690-) id AA22107; Fri, 22 Mar 96 10:19:10
Received: from unknown( by via smap (V1.3) id
sma022082; Fri Mar 22 10:18:54 1996
Received: from msmailgw by with smtp (Smail3.1.27.1 #4) id
m0u0BQ3-000wyTC; Fri, 22 Mar 96 10:18 GMT-0:41
Received: by msmailgw with Microsoft Mail id <3152F03B -at- msmailgw>; Fri, 22 Mar
96 10:23:55 PST
Encoding: 57 TEXT
X-Mailer: Microsoft Mail V3.0
Message-Id: <3152F03B -at- msmailgw>
Date: Fri, 22 Mar 1996 10:24:00 PST
Reply-To: Beryl Doane <BDoane -at- engpo -dot- msmailgw -dot- intermec -dot- com>
Sender: "Technical Writers List; for all Technical Communication issues" <TECHWR-
L -at- listserv -dot- okstate -dot- edu>
From: Beryl Doane <BDoane -at- engpo -dot- msmailgw -dot- intermec -dot- com>
Subject: Developing Online Docs
To: Multiple recipients of list TECHWR-L <TECHWR-L -at- listserv -dot- okstate -dot- edu>

Previous by Author: How to write a functional spec?
Next by Author: Re: Workplace Discrimination
Previous by Thread: Re: Developing Online Docs
Next by Thread: Re. Quick and dirty indexes

What this post helpful? Share it with friends and colleagues:

Sponsored Ads

Sponsored Ads