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.
> There are two goals that appear to conflict: (1) let users know the
> sub-commands are links and (2) maintain the CLI look and feel. But both
> goals could be satisfied by changing the command intro as follows:
> widget - manage widgets in the system
> The following sub-commands are available (click a sub-command for more
> Would a compromise like that satisfy the concerns of both camps?
Well, you'd think... but...
These are some of the same people who, on the one side complain
that the WebHelp's command syntax pages are just a duplication
of the command-line help that's available when the user
But then it's a problem that I use the command-syntax format
as a jumping-off point to include expanded explanations and
links that don't exist in the command-line version of "help",
because it's not the same look any more.
Really, these are the sorts of complaints that arise when
there are no more factual errors/omissions, all the typos
have been cleaned, etc.
The 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.
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.