RE: How to submit new version release information to the Technical writer

Subject: RE: How to submit new version release information to the Technical writer
From: "technicoid" <technicoid -at- cableone -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 14 May 2004 08:05:41 -0600


>Call me old-fashioned, but I prefer people talk to me about this kind
of stuff
>rather than getting a document from someone and be told to wrap it into
the book
>or "make it look pretty".

Call me new fangled, but I like to see a specification. :-) That said, I
would use the spec only as reference material, never as source for the
user docs. I've never seen one detailed in such a way that it would be
useful for anything more than a guide. Make it look pretty? Nope, unless
they want me to write the spec myself. And nothing beats a face-to-face
discussion for getting the intricacies of the application.

>Why do the tech writers need a document to tell them this? Have they
not been involved
>in the project at all? If not, why not?

I agree wholeheartedly. In my last position, the company moved from a
silo model (where the documentation and development functions were
separate and distinct) into a model that included my team's
collaboration from the business case through the design specs. The
latter produced a much better product.


Bill
technicoid -at- cableone -dot- net





^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.



References:
Re: How to submit new version release information to the Technical writer: From: wswallow

Previous by Author: RE: Evaluation of Arbortext and XMLSpy
Next by Author: RE: XML and content management tools
Previous by Thread: Re: How to submit new version release information to the Technical writer
Next by Thread: RE: How to submit new version release information to the Technical writer


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


Sponsored Ads