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: Should I run or is this project doable?... From:Bruce Byfield <bbyfield -at- progeny -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 14 Mar 2001 13:46:12 -0800
Johanna wrote:
> 3) As I mentioned before, there is nothing written
> down spec wise and additionally, the developer is
> given to tweaking the "interfaces" here and there. You
> know what I mean, adding a field here, deleting a
> field there, etc, etc, etc.
This isn't unusual. I've documented more than one project in which
an interface would change between the time I took a screen shot and
positioned it in the document. It's annoying, but it happens.
> 4) The timeframe is... well, just plain stupid as
> anyone can figure out.
That depends on how large the project is. If you're being asked to
document an entire office suite, or a system with a couple of dozen
apps, the deadline's stupid. If it's a single piece of software, the
deadline is possible.
> Well, much here is ridiculous but I could use some
> work right now. I am considering this: going to the
> client, telling him the situation (more
> diplomatically) and that with what little time we have
> to work with, he needs to come up with a very specific
> lists of the tasks he wants me to document. I am
> figuring that if he tells me what he wants the users
> to be able to do, I will be able to document the
> corresponding procedures. I am thinking that a bare
> bones "work in progress" would be possible as they are
> planning to release version 2 of their software within
> a couple of months of their initial release.
This project sounds like what I refer to as documentation triage.
Just as medical triage requires an adjustment in thinking for a
doctor, this project requires an adjustment in your thinking.
If the deadline is firm (and, frankly, I'd be surprised if there was
no slippage that would give you wriggle room), then you have to get
the idea of perfection out of your head. What you produce isn't
likely to be the best documentation that you've ever done - only the
best that you can do in the circumstances. If you scale back any
ideas of perfectionism, you can still produce serviceable
documentation so that the product can get out the door.
If you decide to take this job, I suggest that you need to be
completely honest with the client. Tell them that the schedule is
tight, and make clear that, for you to meet your deadlines, they
have to meet theirs. This sort of honesty always makes for good
working relationships, but, in this case, you also want to protect
yourself against inflated expectations, too.
If you take this contract, good luck. Triage is exhausting, but it
can be satisfying to produce decent work under the increased
pressure of a tight deadline (especially afterwards, when you can
sit back and brag about it - and it does look extremely good on a
resume, believe me).
--
Bruce Byfield 604.421.7177 bbyfield -at- axionet -dot- com
"From the hag and hungry goblin
That into rags would rend you,
And the spirits that stand by the naked man
In the book of moons defend you."
- Steeleye Span, "The Beggar"
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
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.