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.
A friend of
mine has recently been asked by management for his thoughts on what the next
priorities should be for documentation. His thoughts are that the
documentation would be far more useful if the product had a useful interface.
Currently, the product he documents cannot be configured without prior
knowledge of the product, sample configurations taken from training or a
friend, or the documentation. Once you install this product, you get a
confirmation and then a blank screen. You type in the commands, options and
variables from memory or notes, much like you would type a program. At each
line, you have several, sometimes hundreds, of options.
My friend feels there should be some assistance to the user, if not menus and
prompts, something that is quicker than searching through the documentation --
some sort of context-sensitive help.
Now, the audience is of mixed background knowledge, but most are experienced
programmers. The management wonders if experienced programmers would want this
sort of assistance. After all, the management reasons, they are used to