Re: FW: Extreme Technical Writing (was RE: Flexibility and changing r equirements)

Subject: Re: FW: Extreme Technical Writing (was RE: Flexibility and changing r equirements)
From: Ymorrigu -at- aol -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 10 Jan 2002 09:56:57 EST

As the only person to actually admit to being an extreme technical writer, here's a quick breakdown of how the documentation and writing cycles coalesce for my organization:

1. Basic working model is developed along with basic documentation structure. This includes an overview all existing modules and components, and documentation for all existing functionality.

2. Working model plus documentation go to client for formal review. The client can make changes to the design, request additional functionality, or OK basic design.

3. "Final version" is developed. Throughout this time we work closely with the client to determine what else they may need to include, and the documentation goes pretty much piece-meal as new modules or functionality are added.

4. Client accepts final version and the development ceases, or the client doesn't accept the final version and Steps 2 & 3 are repeated as necessary.

Obviously these steps are only a very high level overview, but the iterative nature is obvious. There is an extremely high level of communication between our programmers and our writers, to the point that the writers serve as test users during development. In fact, that writers at my company get to know the systems so intimately that they are the ones responsible for handling support calls after rollout.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

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

Previous by Author: translation companies - SDL?
Previous by Thread: Re: Frame and PS printing
Next by Thread: RE: FW: Extreme Technical Writing (was RE: Flexibility and changing r equirements)


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

Sponsored Ads


Sponsored Ads