[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Tech Writing Question

Subject: Re: Tech Writing Question
From: quills -at- airmail -dot- net
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 17 Apr 2002 23:08:39 -0500


At 3:11 PM -0700 4/17/02, Richard Sanchez wrote:

I have another question regarding writing user
manuals.

Is there often a step where the tech writer has access
to some type of spec type documentation or writers
just start from scratch?

Thanks for all the help so far. This is a great group.


Richard,

Yes, you are supposed to have access to the specifications. There should be two distinct types available: functional and design.

Could you work from them? Yes. If present they could be used.

Should you trust them? No. They are usually out-of-date, poorly written, incoherent, rambling, mismatched data, and usually written by people who think they are writing ok, but actually don't know what to put in these documents.

I have seen functional specifications that included no functional DETAIL. Kind of like getting a 1:1000000 map. When you have to pinpoint something to within 10 meters, a map of that scale doesn't help much. I've used functional specifications that were very specific on design features, which can be more oriented toward marketing.

I've seen design specifications that had good information about the design, including screen mockups, but they were never updated when the function changed, or the design changed.

Most engineers believe that changing the specs can be done after the work is completed. Sure. And after the work is completed why go back and update the specs?

My real beef is that these specifications are the heart of the design process, and if they are kept updated, then the work of producing the product is actually easier. But evidently most engineers prefer to muddle through by trial and error until they get a product for release. The cut, don't measure school of engineering.

So, we are faced with projects that no one really knows what the parameters are, no one knows what the product will do, or how it will look until the end of the project, which is why so many projects are over budget and past deadline. Or are released with missing functions.

This is why you are required to look at the product you are documenting, interview the engineers (hardware or software), and keep turning out drafts until the thing is in final Beta or something close to release.

Some companies do better, but I have never worked for them, so they are only hearsay, probably mere chimera.

Scott


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr

Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com

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

References:
Tech Writing Question: From: Richard Sanchez

Previous by Author: RE: paper documentation vs. online help
Next by Author: Re: Ready to Scream
Previous by Thread: RE: Tech Writing Question
Next by Thread: Re: Tech Writing Question

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

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

Sponsored Ads