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.
RE: RE: How to submit new version release information to the Tech nical writer
Subject:RE: RE: How to submit new version release information to the Tech nical writer From:"John Posada" <JPosada -at- isogon -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 14 May 2004 14:47:58 -0400
It has nothing to do with holes or busy time. It has to do with quality
of documentation.
I've written most of a user's document set from the functional specs,
but much I had to hold off on because the FS documentation was ....weak.
I could have written much better user documentation earlier in the
process if the spec documentation was better, which means the subsequent
departments that use my documentation, such as QA, could have gotten an
earlier/better start...it ripples through the development of the
application.
It also prevented some improvements to the application because changes
that were discussed in development never got documented and subsequently
got lost.
I refuse to base the quality of documentation by available time. I
improve the documentation process to achieve quality documentation.
John Posada
Senior Technical Writer
Isogon Corporation http://www.isogon.com
"Realizing Your Business Goals
Through Software Asset Management"
-----Original Message-----
From: bounce-techwr-l-143723 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-143723 -at- lists -dot- raycomm -dot- com] On Behalf Of Mailing
List
Sent: Friday, May 14, 2004 1:46 PM
To: TECHWR-L
Subject: RE: RE: How to submit new version release information to the
Tech nical writer
John Posada said:
> Up to now, my current department has been responsible for user and
> admin documentation, as well as marketing and web content.
>
> This morning, I went into the office of the other writer and said that
> at our next department status meeting, I'm proposing that we take over
> the creation of the application Functional Specifications, which to
> this point, have been done completely by Product Engineering.
>
> The look of terror on her face was priceless. :-)
You're saying that, "to this point", you have had big uncommitted holes
in your schedules and had been looking for something to occupy your
time? Luxury!
I'm not used to that. I'm more accustomed to holes being relatively
rare, and usually unannounced, and to schedules normally being "up to
here" with stuff that needs to get done, to the point that triage and
prioritization are usually necessary.
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.
