Generic and device specific docs

Subject: Generic and device specific docs
From: J C <tech_writer_girl -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 28 Mar 2005 12:59:21 -0800 (PST)

Here?s the situation:

We have a software product ?Device Software?. Device
Software can be installed on about 25 different
brands/types of devices. The install and use is pretty
much the same no matter what device. But there are
some differences (screenshots, menus on the device
etc) because each device is a little different.

Documentation. Currently there is a different Device
Software manual for each type of device. Boss wants to
go to a Generic Device Software doc and then do a
?device-specific something? for the devices. Generic
Device Software doc and this ?something? would ship
with each specific device.

What do you think those ?somethings? could/should be?
Appendices within the Generic Device Software doc?
Quick Start Guides? Whitepapers? (They call anything
that isn?t a manual or a quick start a whitepaper,
just so you know. I don't know if I can convince them
different. Pick my battles, right?)

Do any of you have similar document situations? How do
you handle it?


Do you Yahoo!?
Yahoo! Small Business - Try our new resources site!


Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

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 for more resources and info.


Previous by Author: Re: new kid on the block THANKS
Next by Author: Re: Word question: sm black squares next to only some heads?
Previous by Thread: Re: Exporting RoboHelp (HTML Help) Files to Arbortext
Next by Thread: Re: Generic and device specific docs

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

Sponsored Ads