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.
Karen West reports: <<I am currently writing an advanced user manual for a
software application that generates reports... I have been asked to change
the word PRINT to something more appropriate... The thinking behind this is
that PRINT is rather old fashioned and usually means to produce a hard copy.
With the advent of spreadsheets, the web, email etc not all reports that are
generated are actually printed. I agree with this up to a point but it does
produce problems as the substitutes, SHOW and DISPLAY, do not always fit.>>
Given the last sentence of what I quoted, "print" may be the correct word in
some cases, and your reviewers may just have to suck it up and deal with the
fact that some of us still love our paper. <g> The more general point I'd
like to make is that one very good general solution may be to use both
"print" and "display" to explicitly indicate that both options are possible.
"Viewing" is probably the best single-word alternative if you really need a
single-word approach because viewing refers directly to the user's need ("I
want to see the information"), not the software's function ("the software
displays or prints"). The main problem with a single word approach is that
it conceals facts that you might want to make explicit, such as the fact
that you can print information once you're viewing it. That may be
sufficiently obvious from context that this is a non-issue.
<<"When using comparative percentages the second item must be explicitly
specified as a print item in the body of the SUM report.">>
"To display or print a SUM report that includes comparative percentages,
specify that the second item [what's that?] must be included."
<<"This chapter describes how to create summary reports that show numeric
information, such as the total values of orders, without needing to print
detailed information from each record.">>
"This chapter describes how to create numerical summary reports, such as the
total values of orders. You do not need to print or display detailed
information from each record." [The latter part might be clearer if you said
something like: "You can print or display both detailed information from
each record and overall summaries."]
<<The problem is more pronounced for section headings, e.g. "Displaying
Occurs Fields" just does not sound right to my ears whereas "Printing Occurs
Fields" does.>>
Again, the heading would become "printing or displaying..." or some variant
thereof.
--Geoff Hart, geoff-h -at- mtl -dot- feric -dot- ca
Forest Engineering Research Institute of Canada
580 boul. St-Jean
Pointe-Claire, Que., H9R 3J9 Canada
"User's advocate" online monthly at
www.raycomm.com/techwhirl/usersadvocate.html
"Writing, in a way, is listening to the others' language and reading with
the others' eyes."--Trinh T. Minh-Ha, "Woman native other"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Buy RoboHelp Deluxe starting at only $798: you'll get RoboDemo, the hot new
software demonstration tool that's taking the Help authoring world by storm,
together with RoboHelp Office. Learn more at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.