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.
On Sun, Nov 3, 2013 at 9:42 AM, Editor in Chief
<editorialstandards -at- gmail -dot- com> wrote:
> Not so fast. We feature Breadcrumbs navigation aid prominently at the top
> of every Webhelp topic. If a single topic has more than one link in the
> ToC, it breaks Breadcrumbs (at least, as they are implemented in WebHelp,
> by Flare.
>
> What do other people normally do?
>
> In case the above was obscure, here's an example:
>
> Every computer clock drifts. Many applications need reliable time, both
> within and among connecting systems. We provide three options to achieve
> that:
>
> a) use simple Network Time Protocol (NTP) to receive a signal from a
> standard internet time source, and keep your system's clock adjusted that
> way.
>
> b) do the same as "a)", but with secure NTP, which uses certificate-based
> authentication to ensure no nefarious substitutions of time-correcting
> signals
>
> c) if you aren't allowed to use NTP, then correct your own time with
> built-in drift-correction tools - it works, but is a bit more hands-on.
>
> We estimate that most customers would (or should) use method "b)", so
> that's the one that appears in the Config Guide. But, for completeness,
> that method should appear in the Admin Guide, alongside the other two
> methods. . . especially when a customer might keep only the Admin Guide
> (PDF or printout) handy.
>
> So, duplicate the topic, and risk the copies getting out of sync?
> Or use just one topic for a description/instruction, point to it from two
> or more places, and live with the fact that it breaks the Breadcrumbs
> feature?
> OR.... some third way.
>
> --
> __o
> _`\<,_
> (*)/ (*)
> Don't go away. We'll be right back.
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.
>
> Learn more: http://bit.ly/ZeOZeQ
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as robert -at- lauriston -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
>
> Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.