Quality of source material from Development

Subject: Quality of source material from Development
From: Salan Sinclair <salansinclair -at- shaw -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 11 Dec 2001 07:01:02 -0800

How much written information should software development department provide
for a technical writing department?
Option 1. Enough for tech writers to write the documentation, with few
questions.
Option 2. Enough for tech writers to get a complete scope but not the
details.
Option 3. Enough for tech writers to get started, or whatever information
developers can provide in the time allowed.

A friend of mine is a Doc Manager at a new company. She expected Option 1,
but the Dev Manager is delivering Option 3.

The documentation is for command-line interfaces for new networking
software. (The question could apply to any software, but sometimes GUI
software is easier to write by simply working with the product.)

The Doc Manager says the advantages of good source material are:
-improves accuracy, because the experts (developers) are providing the core
information
-improves efficiency for developers who provide information one time to
several audiences: Docs, QA, training, and marketing
-improves productivity for tech writers

The Dev Manager says the disadvantages of good source material:
-reduces developers' productivity because developers don't have the time to
provide source material
-is unnecessary because all the information is available to tech writers in
the code
-is unnecessary because tech writers can get the material through other
means.

I've never seen anything but Option 3, but my friend has worked only in
environments using Option 1.

What has been your experience? Can you make better arguments for the
options?
Should tech writers (or a TW Manager) have a say over the option chosen, or
is that for Development to decide?
Are there other options? Hire more tech writers? Hire programmer/writers?
Hire a tech writer for the Development department?

Thanks,
Salan



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
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.



Follow-Ups:

Previous by Author: Re: the new economy and finding a job
Next by Author: Re: Quality of source material from Development
Previous by Thread: Re: Training a new writer
Next by Thread: Re: Quality of source material from Development


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


Sponsored Ads