RE: Differentiating between software versions in help articles

Subject: RE: Differentiating between software versions in help articles
From: "David Artman" <david -at- davidartman -dot- com>
To: "Nina Rogers" <janina -dot- rogers -at- gmail -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 13 Mar 2015 06:26:40 -0700

I concur with Gene and Julie--each version of the software should point
to its own, unique helpset. If those sets should happen to have
identical articles, oh well: storage is cheap and single-sourcing is A
Good Thing.



As far as validating/indicating which version of help the user is
viewing, that would be a trivial thing to show in the header (along
with modified date in footer, perhaps). In essence, that would be the
helpset's 'site title'; and each article would be the H1 of the topic
(at highest level):

Software 2.0 Help - Fooing the bar

-or-

Software 2.0 Help

=Fooing the bar=



I think that trying to indicate applicable version in the title will
become a nightmare. What happens once you're at v4.5--you going to have
article titles that read "Fooing the bar (1.0, 2.0, 2.2, 2.5, 3.0, 3.5,
4.0, 4.5)"? What happens when v3.5's "Foo" function is slightly
different from v3.0? And more importantly: *Who cares* what versions a
given article applies to, if users tend to only have one version
installed and that version consistently points to its correct topics?
Your manager's instinct to show all versions might be a case of one's
knowing how the sausage is made leading one to think sausage eaters
want to know (they really, really don't!).

HTH;

David
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Adobe TCS 5: Get the Best of both worlds: modern publishing and best in class XML \ DITA authoring | http://adobe.ly/scpwfT

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


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


Follow-Ups:

Previous by Author: Re: Backpan or backplane?
Next by Author: Suitable applilcation to help build a glosary for CE translation
Previous by Thread: Re: Differentiating between software versions in help articles
Next by Thread: RE: Differentiating between software versions in help articles


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads