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.
> -----Original Message-----
> From: Spectrum Writing [mailto:info -at- spectrumwritingllc -dot- com]
> Sent: Tuesday, December 22, 2009 3:43 PM
> To: McLauchlan, Kevin; techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: RE: Using conditions in multi-destination docs
>
> The only warning/caveat that I see:
>
>
> "Your [Prod1][Prod2] arrives from the factory with default
> network settings. Before using the appliance configure
> for your network as follows:
>
> From personal and frequent experience, conditionalizing
> [Prod1][Prod2] right
> in the middle of a sentence with two conditions can get
> tricky and messy,
> especially if you don't conditionalize the necessary spacing
> before and
> after correctly and it results in a lot of extra cleanup/fix time.
>
> My suggestion:
>
> "Your [Prod1]arrives from the factory with default
> network settings. Before using the appliance configure
> for your network as follows:
>
> "Your [Prod2] arrives from the factory with default
> network settings. Before using the appliance configure
> for your network as follows:
>
> and conditionalize each statement with Prod1condition or
> Prod2condition as
> appropriate. This approach can save you lots of grief and
> time later on!
That's a good suggestion, especially with MadCap Flare, which
makes it vary easy (one click) to select a free-standing block,
but harder to accurately select from within a para, particularly
when conditions overlap.
It does require a bit more writing (not much with cut'n'paste)
but probably saves time in the long run. Much clearer to read,
on-the-fly, months later.
Sold.
Thanks,
- KevinThe information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Help & Manual 5: The all-in-one help authoring tool. True single- sourcing --
generate 8 different formats and as many different versions as you need
from just one project. Fast and intuitive. http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-