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: Big Time Help From:"bwolf" <bwolf -at- scheidt-bachmann-usa -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 7 May 2001 13:03:30 -0400
Joe:
Perhaps this is management's way of sticking it to you? Or, could this
situation be a mutual misunderstanding? May they reasonably expect you to
produce a task-based document? During the interview, did you give them any
reason to believe you could produce a task-based document if you knew the
components?
BW
-----Original Message-----
From: Joe McPherson <zenpickle -at- zensearch -dot- net>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Monday, May 07, 2001 12:31 PM
Subject: Big Time Help
>Have any of you had your entire job on the line based on one document?
>
>
>
>I'm having that trouble now. The problem is that, well, it's a common
problem. Management has a picture of the document they want, and all my
prodding, questioning and divining is not extracting from their minds any
hint of what they want.
>
>
>
>A LITTLE HISTORY
>
>This is a small pamphlet describing the organization's backup methodology.
Having no experience with networking, I had them break it down for me and
explain it in detail. I met with a few technicians and the managers who put
the system together and want this document written. They broke the network
down component-by-component. And that's how I wrote the doc, I broke it
down into components and described how each one figured into the backup and
recovery process.
>
>
>
>Turns out that a component-based document is not what they want. They want
a task-based document. I'm asking them what tasks do they perform related
to backup methodology. I have yet to get a straight answer.
>
>
>
>QUESTION
>
>What I need to know is if any of you have worked on documentation for
company networks, particularly backup methodologies. I have been giving
myself a crash course on networking, and I'm having trouble understanding
how a networking technician would use a document such as this.
>
>
>
>Also if anyone can point me to documentation online that could give me an
idea so I'm not trying to reinvent the wheel here, that would be great.
>
>
>
>Frankly, I lose this job if I can't produce what management has in mind, so
I'm a little tense today. I also have little time to produce it (the new
outline is due later today).
>
>
>
>I've held three technical/web writing jobs before this, and none of them
have been this intense, vague or critical. Is this a normal situation?
>
>
>
>- Joe McPherson :-)
>
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See http://www.infomap.com or 800-463-6627 for more about our solutions.
---
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.