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:Re: Doc for multiple interfaces From:Mitch Berg <mberg -at- IS -dot- COM> Date:Thu, 24 Apr 1997 10:31:59 -0500
Charles Fisher wrote:
> We are already writing what we call "interface-independent" doc, in which
> we don't discuss interface specifics for commands. For example, instead of
> writing "Press F10" or "Select File|Save," we simply write "Save your
> work." There is a separate doc that gives specific about how to SAVE in
> each interface. What we need help with is how to show screen images with
> respect to these different interface flavors. Do we
>
> Produce a separate doc for each style of screen?
> Produce one doc that includes all styles of screens?
> Pick one style of screen and produce doc using it, not showing others?
Assuming your screens have _generally_ similar layouts, this might
work. Frame does this - FrameMaker manuals show, I believe, the Mac UI
in all publications.
> Produce doc that does not have any screen images?
>
Another possibility that I've used: assuming the various interfaces are
generally similar, produce a "generic" UI illustration - essentially
line-drawings showing basic controls, without depicting controls
specific to a particular UI.
In my case, these line drawings were simple, black-and-white, with only
basic control outlines, menus and labelling.
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
