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: Screening Outside Agencies From:Rebecca Rachmany <purple -at- NETMEDIA -dot- NET -dot- IL> Date:Sat, 24 Jan 1998 18:41:47 +0200
>
> I have been asked by my boss to find an outside agency or contractor to
> come in and write a user's (software) manual. I have never done this
> before, and would like to know if anyone has any suggestions on the type
> of information I should be asking for.
>
Moria:
Our company, being a subcontractor, writes a regular newsletter which is
targeted to teaching people how to pick subcontractors. We recently wrote
an article on working with subcontractors for high-tech marketing. You
might want to take a look at it, even though a lot of it is specific to
marketing. It's at http:/3/www.tech-tav.com/NL
Here are some points I would look for:
* When a contractor comes out of a meeting with you, she should have enough
of an understanding to provide a price estimate based on a sketchy outline.
For example, we had to document an API, so we needed to know at least how
many commands there were, how many arguments the commands have, and about
how long the description of each command would be. On top of that we added
an introduction and an index into our price estimate.
* If there are big differences between price estimates, be cautious about
ones that are very inexpensive. The contractor may not know what he is
getting into Dan you will find yourself going way over budget.
* Pay careful attention to what the contractor asks you about the project.
Does he just let you take the lead in saying we need X pages by Y date? She
should be asking more in-depth questions about the scope of the project and
the subject. If the contractor doesn't ask too much about your product, you
have to wonder how they are going to assign the right person to the
project.
* Ask how the contractor deals with the workload of its writers. Some
contractors give writers several projects simultaneously. Make sure the
contractor will take your deadlines seriously.
* The contractor should have understanding of the subject matter, at least
on a basic level. Even though the sales rep usually isn't the person
writing the manual, they should have some technical know-how. Otherwise,
how can they do quality assurance?
* Ask them about work procedures. How much time per week (per page,
whatever) do they need to sit with SMEs? How do they approach the work? How
do they compose the outline? How much quality assurance and
editing/proofreading to they provide? Who has to deal with the layout? Do
they take care of the interface with the printer? Do you get original files
(DTP, Graphics, and RTF for on-line help) when they are done?
* Check references. Find out as much as you can about the work procedures
of the contractor.
* Check writing samples.
Rebecca Rachmany
General Manager
TECH-TAV technical and end-user documentation
P.O. Box 2419, Tel Aviv 61024
purple -at- netmedia -dot- net -dot- il
Phone: 972-3-6090416 http://www.tech-tav.com
