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:Lists of Shipped Components From:Nancy Allison <maker -at- verizon -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 25 May 2010 15:02:06 -0500 (CDT)
If your company ships physical products, where do you put the checklist of items they should receive?
I've inherited a project that puts the list in a user manual. On page 10 of a 40-page manual it tells the reader to inspect each item and check it against a list of standard items (which is printed right there on page 10).
In the old days of physically bound manuals, that always seemed especially awkward because the only way you could be reading the manual was to have opened the box and taken everything out. It seemed unlikely that the very first thing anyone would do was dive for the manual and scan it for a list of shipped components . . . people were much more likely to look at the packing slip and no more.
Nowadays, with manuals shipped as a PDF on a CD, or downloaded from a web page, I find it even less likely that anyone will have printed and skimmed the PDF in anticipation of opening the box and checking off its contents against a list in the User Guide. I still think they'll look at the packing slip and no more.
My questions are these:
1. Do you include any section in your user guides discussing what to look for when the customer opens the shipping container?
2. If not, how do you handle the issue of clients checking that they've received the correct items and that everything looks like it's in good shape?
Gain access to everything you need to create and publish documentation,
manuals, and other information through multiple channels. Choose
authoring (and import) as well as virtually any output you may need. http://www.doctohelp.com/
- Use this space to communicate with TECHWR-L readers -
- Contact admin -at- techwr-l -dot- com for more information -
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-