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.
You don't mention what type of document you're tasked with or what the
device does (communications box??), so I can't be too specific. But, based
on my experience with telecom products, you should be able to create a
hardware getting started manual in two weeks that tells how to install the
box, wire it up, service it, and configure it using a half-dozen or so
step-by-step scenarios. While the engineers and product marketeers are
cobbling together the configuration scenarios, you can be
writing/illustrating the install stuff. Painful, but it can be done.
Obviously what you'll be releasing won't have been through more than one
review cycle, so it'll be rough in spots. Immediately after releasing it,
start work on the next revision!
Assuming your comm. box uses lots of software command, you'll also need a
software reference guide that will take much longer to write (at least 6
weeks for a 200 page guide illustrated with screen caps).
Good luck,
Chris
___________________________________________
TopTechWriter.US http://www.toptechwriter.us
Award-winning technical writing and illustration services.
>
> My employer has been developing a new multi-processor controlled comm. =
> box
> for over a year now. I repeatedly asked and prodded them regarding my
> documentation duties to no avail. I've tried to talk with developers an=
> d
> engineers about the product during it's development to try and learn ab=
> out
> it.
>
> Now I get this email from my boss's protoge saying they need a new manu=
> al
> for this very complex box in two weeks. I don't think I can produce a
> manual for this thing in two weeks. I haven't said anything to them yet=
>
> though, I'm waiting to hear from you all.
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
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.
