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.
The usual applies here. It all depends on the product.
For our products, IO cards, we include a minimal
installation guide as hard copy with the hardware.
Just enough information to get the product up and
running, configured, and verified. We expect our
customers to throw it away afterwards, so it is
minimalist in nature. The full doc set is available
on the web, which includes the install info.
We also expect customers to purchase extra cards
and leave them on the shelf until a need arises.
For a product such as this that is easily moved
around, keep it hard copy.
At a previous job, we considered on-line docs, as
we were a manufacturing site, and provided the
instructions in-house to dedicated locations.
Even in this case, we opted to not use online
only docs, as operators wanted to carry the docs
to the job, mark on them, and be able to look at
them while laying on the ground looking up at the
hardware. We spec'ed the ability for the operator
to print the docs as needed. Sme did, some didn't,
it depended on the experience of the operator.
At yet another gig, there were times when the
product could go into a secure site, where there
was no internet connection, and every data disk
that was carried in, stayed there for security
reasons, including hard drives. Again, hard copy
only.
Think through who uses the doc, where, and when.
Will they -always- have access to a computer, with
a high level of confidence it won't go down?
Can it be burned onto a disk and used from a laptop?
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
