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: screen dumps in books From:"Susan W. Gallagher" <sgallagher -at- EXPERSOFT -dot- COM> Date:Mon, 18 Jan 1999 12:37:24 -0800
At 03:02 PM 1/18/99 -0500, Brierley, Sean wrote:
>...writing s/w release notes for VAX/VMS...
>programming wants ... numerous screen dumps...
>... one or more screen of textual information...
>I explained ...
>... I am looking for general opinions about ... screen dumps.
>Also, does anyone have a thought about how I should discuss this issue
>with those who want the screen dumps to mirror the screen?
You'll probably find lots in the techwr-l archives about screen
dumps/screen shots in manuals. In general, unless they make a
significant contribution to the text... Well, you know.
The important part of your question, however, is how to get this
across to "programming" -- somehow, you've gotten yourself into a
situation where you are not viewed as the expert. You need to
establish yourself as the authority here, otherwise "programming"
is going to walk all over you.
I found myself in that situation once -- a VP of marketing thought
he knew exactly what the user needed an I needed to take back
control in a hurry. I dug through about four years of STC pubs,
borrowed some books from friends, etc., came up with about 100
to 150 pages of research that supported my position and made
photocopies. I then presented the whole intimidating stack of English-
nerd reading to the gentleman in question and said, "I understand you
have some questions about my plans for the user manual. Here's is
some of the research on which I've based my decisions. If, after
you've caught up, you still have questions, I'll be happy to discuss
the issues with you."
The trick, then, is to walk away before he scrapes his chin up off
the floor. <giggle>