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.
Thanks for your feedback - greatly appreciated. Yours, and the thoughts
of others coincide with many of my thoughts, but are helping to focus
and look at my options.
Question: How does one have user-customizable Help? I really like that
idea, but have no idea how it would be implemented in theory. Currently,
we are using RoboHelp V7 to produce FlashHelp. I do not see them
investing in an Additional authoring tool.
With regard to your idea for short training videos, I introduced this
idea with some difficult procedures in this current release. They were
very happy with the idea. Your thoughts made me think that perhaps we
could do something similar with the theory, but perhaps using some
flowcharts and diagrams to help users see how all the pieces of the SW
Obviously, Business Manager is not the real name of the SW, nor is the
stated purpose. (My client was very concerned that I not share any
proprietary information if I sought advice).
What may not be so obvious is that there is a customer-side of the SW,
and an administrative side that the business works with (to work with
Interestingly, there is no online Help for the customer, unless the
Business creates it (which they will never do). I've suggested to my
client that we offer to make a customized Business-branded Help that
they can provide for their customers, since once I make one version,
single-sourcing and variables will enable relatively easy customization
for each business using the SW. The clients liked that idea and is
currently exploring options for this.
Well, all for now. THanks for taking the time to answer.
DWerder -at- t-online -dot- de wrote:
> Dear Deborah,
> Here are a few rough answers to your questions:
> 1. Training courses for users in the beginning, before using the software
> 2. Have all the information in one large help file with a good TOC and
> 3. Access to the online help via a customizable start page
> 4. You could also have this start page automatically adjust to the
> user's level of knowledge. This should be based on usage data, which
> pages has this person already seen etc.
> 5. You could offer a guided tour as part of the online help, e.g. one
> or more short training videos that should also be available from the
> start page of the online help.
> 6. The topics of the help system should always offer a brief
> explanation of "What is this all about? Why do I need to know this?"
> before the section that actually explains how to do something.
> You suggested
> "Separate help systems that connect one way (Say a theoretical
> help that links to the HOW to, but not the other way around)."
> I think this is only an option if certain groups of users will only
> need portions of the software.
> In my opinion it is always good if users have the chance to see the
> "big picture". If they don't want to they can still leave out the
> sections they are not interested in. They should be there, though, for
> those who need to know.
> As to your second question,
> "For example, if the real name of the software is Business Manager,
> and the upgrade portion is XY System, how do you feel about the
> following text? " The XY System, or XYS, manages business statuses, the
> rules for achieving those statuses, and processes business activities
> against these rules. XYS is not a module within Business Manager, there
> no XYS page or section of Business Manager that is labeled XYS. Rather,
> XYS is the technology that enables business processing..."
> From a user's perspective, this information doesn't seem so relevant
> to me. I would rewrite it as Geoff already suggested. A process
> running in the background is only interesting to users if they
> interact with it in some way.
> Excuse the style of this mail, I did not have time for a proper edit.
> Greetings from Germany
> Doris Werder
> Technical writer (member of tekom) and state-certified translator
> (member of BDUE)
> Doris Werder
> Technical writing and translation
> English>German * German> English * Spanish> German
> Electronics * IT * Politics
> Jahnstrasse 8
> 63450 Hanau
> +0049 6181 160431
> dwerder -at- -t-online -dot- de
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-