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: Web Server & Documents--long From:Bill Burns <BillDB -at- ILE -dot- COM> Date:Thu, 3 Apr 1997 09:45:00 -0700
Kate Folse asks:
Does anyone have any insight on creating/distributing documents
for distribution on a web server? I have just been assigned to research
and figure out how to use the inter/intranet as a means of document
development and distribution.
8< 8< 8< 8< snippety >8 >8 >8 >8
I realize I have a lot of possibilities and options b/c no prior docs
exist. Should I
create docs in Word/Frame and convert them? or should I start out just
In either case, which tools are best for that on a PC? In a past life I
WebMaker to accomplish doc conversion on a unix platform and was not too
with the results, but that could have been a result of the source docs.
The decision on the form of your documents depends on the needs of your
users. You need to answer a few questions:
1. To which platforms must the documents be delivered?
Some of your software options may be limited by this issue. It may
determine which web browser would best suit your needs.
2. How are the users going to access and use the documents?
Will they download them and read them using locally installed
Will they print?
Will they read them online?
Will they use the documents to find quick, need-to-know information,
do they need to gather detailed information for research?
3. How (and by whom) are the documents going to be maintained?
If nonwriters will be distributing information on this intranet, make
to use tools/formats with which they are familiar (e.g., Word,
may also want to develop templates for them to use to encourage
4. How are the documents going to be managed?
If you are using a document database (Saros or something of that
you need to determine who will have author access to documents. If
have a large corporation, you may want to plan for central groups in
departments who can either manage their departments' documents or
arrange for people to learn the correct use of the management tools.
If you are using a web server, you'll want to design a directory
will allow you to organize the documents consistently. This directory
can also be used to set access rights and establish some security
your control over security may be better with a document database).
5. What additional features (multimedia, database functions) do you need
to incorporate into your system?
You might want to allow Cold Fusion/SQL queries on database documents
on individual databases that house HTML fragments. You might also
allow users to enter information into databases from the web.
If you're going to use multimedia, you'll want to consider packages
their own solutions. For example, Netscape comes with support for
and video media. These applications may have limitations, so if you
use them, you'll need to be aware of what they offer.
I'm sure I haven't covered everything, but I hope this helps.
billdb -at- ile -dot- com