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:I can now die a happy guy From:John Posada <JPosada -at- book -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 10 Sep 2002 14:22:22 -0400
This morning, at the daily developer status meeting, the boss asked for
comments from each developer that would explain the primary reason that
their efforts are running behind. Was it testing? Debugging? Maybe script
TO A MAN (Ok, one was a women), their response was that they thing they were
doing that was taking way more time than they expected was the documentation
part of their effort....basically, the process of documenting their code.
As a developer creates or modifies their component, they must document
certain aspects of it...aspects that only they can answer...information
contained in the code. (Do I hear someone say that I should read the code?
Anyone out there understand "monk") The information they send me, I then do
many other things with...flows, dependencies, API-like documentation,
business rules, etc.. The document they are filling out is pretty much a
component profile form, maybe 3 pages.
I told my boss I'd waited 12 years to hear a table full of developers admit
Senior Technical Writer
jposada -at- book -dot- com
Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l
Acrobat & FrameMaker Seminars: PDF Best Practices, FrameMaker-to-Acrobat
Advanced Techniques, FM Template Design, Single Sourcing with FrameMaker
in Brussels (Oct), and in Montreal & Dallas (Dec): http://www.microtype.com/1
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.