Documenting an OEM product

Subject: Documenting an OEM product
From: Margaret Smith <msmith -at- aros -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 29 Nov 2001 12:09:46 -0700

Hey there:
I'm on my own and flying blind. My client develops telecom products that will be OEM'd to one or more resellers (who are likely to be very large companies). I'm producing "user" documentation that encompasses multiple audience levels and multiple task types. My question is this:

Given that my documents will probably not be distributed in their native state, what are the most useful formats and doc structures for you writers out there who will get to "productize" my documents? In other words, should I lump Installer/Support level ops/End user ops in the same manual? Produce three separate manuals as I envision their usage? Produce fairly basic, Word-formatted source docs without a lot of fancy layout attempts? (It is Word, after all.) Produce basic, functional graphics?

Do companies still just slap their own covers on OEM manuals? What are your various experiences, war stories, preferences when you get to deal with OEM documentation?
Thanks




Margaret Smith
Abet Information Design


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: RE: document layouts
Next by Author: RE: "Turn on the radio?"
Previous by Thread: RE: Providing editable docs to clients
Next by Thread: RE: Documenting an OEM product


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


Sponsored Ads