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.
The small start-up where I work is still in anarchy mode, so I have situations such as this: a software engineer was contacted directly by a customer, asking for instructions on a procedure. The engineer wrote up the instructions in whatever format pleased him, sent out the documentation, and then notified me of his fait accompli. We have procedures in place for documentation, which include review and approval, and this guy simply bypassed them. I know there will be no consequences to him. :) My problem is this: I have now reviewed, edited and properly formatted his instructions. It is now authorized for distribution to customers.
My question is: should I go ahead and send the updated, proper document to the customer? Would it be confusing for them to receive two documents that said essentially the same thing? Should I wait until there is an upgrade? I would rather our customer had a well-structured, proper-English document (which IMHO is much easier to understand) with part numbers and everything, but possibly it would cause more confusion than it is worth. Has anyone else been through this sort of thing? What did your company do?
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
