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.
Recently our company has been shifting paradigms. We used to provide
Service Manual documentation to our Global Service Engineers. We now
create small procedures all linked to a website for them to use. There
are common subsystems used by many products now. We now have a problem
I am finding very difficult to solve. I wanted to see if there were any
ideas to help give me a fresh perspective.
Currently, if a document needs no change except that it now is
applicable to a new product, the new product must be added to the title
and the revision must be rolled. This affects hundreds of documents
sometimes.
End User issue: There may be 3-6 product names in the document title
before you get to the procedure title. Example (Product X, Product Y,
Product Z, mechanical alignment procedure). This is not very readable.
Publication Issue: This work is time consuming. The technical writers
spend more time ensuring the document is administratively accurate as
opposed to technical content accuracy or innovative ideas for a better
Publications Department.
I would like to change our template so that the product names are
removed from the title and part of the metadata. The Manager in charge
of document release insists that the product name must be in the body of
the document.
Has anyone had to deal with these issues that can offer suggestions?
Thank you for your responses in advance and have a wonderful week!
Take care
Patrick Millard
Technical Publications
KLA-Tencor
Phone: (925) 493-3533
Pager: (888) 513-0638
Patrick -dot- Millard -at- kla-tencor -dot- com
New from Quadralay Corporation: WebWorks ePublisher Pro! Easily create
14 online formats, including 6 Help systems, in a project-based
workflow. Live, online demo! 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.
