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.
Subject:documenting a programmable user interface From:Karen Otto <KAREN_OTTO -at- HP-SPOKANE-OM2 -dot- OM -dot- HP -dot- COM> Date:Mon, 3 Jun 1996 11:16:59 -0600
Item Subject: cc:Mail Text
We have a product which has both a manual and programmable user
Up to now, we have put great detail into the manual user interface,
and provided only syntax reference railroad diagrams for the
We recognize the needs of our customers, and are busy developing new
ways of linking the programming commands to the screens. Our customers
need to link fields to commands, and to understand what the commands
I though for a while our best way would be to just do it as a command
dictionary. That is, have one entry per command, with things like:
Because the commands map so closely to the fields on the screen, I
think we can do better than this.
Some ideas we are trying:
- include syntax examples with field descriptions
- point to the command reference from the field descriptions
1) do we need to eliminate the syntax diagrams all crowded onto a few
pages in favor of a many paged, descriptive command reference?
2) Is a command list (compact listing of commands), plus a command
dictionary (see above) the most common way to go?
3) Does anyone have a silver bullet solution?
karen_otto -at- hp-spokane-om2 -dot- om -dot- hp -dot- com
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net