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.
Gerry Seguin says: <snip> So I'm interested in knowing what methods
people have used to distinguish
optional components in the text to users. I'm thinking it should be
something that is easily recognizable so they can learn it once and then
skip those sections that might not apply to them. </snip>
I either use separate sections or distinct heading styles to let users know
what information applies to them.
The section titles and/or headings include the information they need to
know to distinguish which machine(s) each portion of the manual is for.
Sometimes, this is differentiated by model. Other times, it is
differentiated by serial number.
If there is a large amount of information that is different, I use separate
sections devoted to each set. If there is just a little, I use distinct
heading styles.
Personally, I have found this method to be quite helpful, as it reduces the
number of manuals I need to maintain. The biggest benefit of fewer manuals
in my situation is less expense incurred for translations.
If you would like to see a sample of what I'm talking about, please email
me off list.
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by Cub Lea, specialist in low-cost outsourced development
and documentation. Overload and time-sensitive jobs at exceptional
rates. Unique free gifts for all visitors to http://www.cublea.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.