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.
About a month ago, I tracked down a document put together by our design
department that described a new application. It would be classified as a
Functional Requirement. The software didn't exist...not code-line-one.
The screens in the document were hand drawn, scanned, and placed in.
Around here, the history has been similar to most companies...the beta
of the application is presented and at that point, someone starts
writing the document. The application availability is planned to happen
around May 1.
Since I'd just delivered a product document and was between product
releases, I decided to see if I could create the kernel of a User Guide,
pretty much as a framework for future document development. I ended up
with about 123 pages of manual for an application that didn't exist
yet...purely based on the Functional document and an Excel requirements
document I found on the printer that I "borrowed" (I made a
photocopy..so shoot me).
So...last week..The Project Manager calls a kickoff meeting to outline
their documentation expectations. He walks in with a one-page project
plan and I walk in with 4 copies of the draft document and my laptop
with a draft of the help.
He was floored. Mind you, this places the document part of the project
about 2 months ahead of schedule.
Hmm..what's the reward for this? Candy? Bonus check? Parade me around on
their shoulders? Nah...this morning, he calls a meeting for 4pm. The
subject of the meeting? "When can we have the next draft so that QA can
start writing their test cases?"
sigh
Thank god it's Friday evening...this was the LONGEST week...
ROBOHELP FOR FRAMEMAKER AS LOW AS $299! Offer expires March 31.
Publish your FrameMaker documents online -- quickly and easily!
New licenses are only $899 for one and $499 for additional licenses.
Use a competitor's product? Switch to RoboHelp for FrameMaker
for only $299! Buy today: CALL 1-800-462-4420 or 1 858-847-7900.
Hurry, offer expires March 31 2004.
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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.
