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.
I would say, don't bother including the title of the main doc in the title of the addendum. So instead of the samples you gave in your post, just call it "Addendum X: Something". After all, the reader already knows the addendum is specific to that particular main document, so repeating the title of the main document is an unnecessary redundancy. Save yourself the key strokes and save the reader the eye scan time. Also, if the reader has to tell someone else the name of the addendum over the phone, he will want the shortest title that allows him to clearly identify the addendum.
In your document library, of course, you will need a filename or some kind of record keeping that clearly ties each addendum to its owning main document.
I have a âgenericâ version of a doc and Iâm preparing customer-specific addenda for (of course) customer-specific info.
There wonât be an addendum for all customers, only for customers whose implementation has been customized to a degree that the generic doc is insufficient (with respect to one-off features, additional options for some generic features, deployment info thatâs different due to some customer system oddity, and the like).
But... I keep going back and forth as to what to name the addenda.
The main doc is âProduct-Name Operatorâs Guideâ.
So, which of the following is better, in terms of finding the doc in a folder with lots of similarly named docs (important not only for me and doc repository users, but also for the customer), making it easily discoverable by customers, and likely other things that I havenât realized the importance of yet?
* Customer-Name Addendum to the Product-Name Operatorâs Guide
* Product-Name Operatorâs Guide: Customer-Name Addendum
* something else?
Thanks for your thoughts,
-Monique
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com
