Doc for multiple interfaces

Subject: Doc for multiple interfaces
From: Charles Fisher <Charles_Fisher -at- DATATEL -dot- COM>
Date: Thu, 24 Apr 1997 11:27:14 -0400

Hi all -

I am seeking advice and alternatives for documenting the same product that
runs in multiple interfaces. Our product runs in 4 different interfaces
(character-based, two Windows interfaces, and a web interface). We're
struggling with how to handle these interfaces and screen images in the
doc.

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?
Produce doc that does not have any screen images?

If you have seen or produced doc like this, please share your experience.
Thanks -

REGARDLESS of whether you reply to the entire group, please reply to me
separately so I'll be sure to get your reply. I subscribe to the group in
digest mode. Thanks.

Charles Fisher
Documentation Area Leader
Datatel, Inc.
cdf -at- datatel -dot- com

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


Previous by Author: E(-)mail addy label (was: RFC1983 (Was E-mail or e-mail))
Next by Author: Dictionary Reference Request
Previous by Thread: Re: Doc for multiple interfaces
Next by Thread: Re: Doc for multiple interfaces


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads