[Framers] "Exemplified" - use in technical documentation?

Fred Ridder DocuDoc at hotmail.com
Tue May 31 10:44:09 PDT 2016


I agree with other responses that a figure is *not* an example, so that "exemplifies" is not at all the right word. 

But I also suggest that in many cases it would be better to cast the sentence in the active voice ("Figure x.x shows" something) or the imperative mood ("See Figure x.x") rather than the passive voice (something is "shown in Figure x.x"). If the passive voice is preferred for some reason, I would suggest a transitional word ("as shown in Figure x.x") to be more idiomatic than the form that leads with the passive verb.

-FR 

________________________________________
From: Framers <framers-bounces+docudoc=hotmail.com at lists.frameusers.com> on behalf of Stephen O'Brien <sobrien at innovmetric.com>
Sent: Tuesday, May 31, 2016 12:50 PM
To: Frame Users (framers at lists.frameusers.com)
Subject: [Framers] "Exemplified" - use in technical documentation?

Hi,

A new technical writer uses « exemplified in Fig. X.X» in captions to describe images in our technical reference documentation for a quality control software.

I have asked that a simpler synonym be used (shown in Figure X.X).

I consider that "exemplified" is not a commonly used term (I haven't heard or read the term in years) and is not easily read. The writer does not want to give the term up, considering it equal to "illustrated in".

What do you think?

Stephen O'BRIEN
Coordonnateur de la qualité documentaire et rédacteur technique senior | Quality Coordinator for Documentation and Senior Technical Writer
InnovMetric Logiciels | Software
sobrien at innovmetric.com<mailto:sobrien at innovmetric.com>
T (1) 418.688.2061
F (1) 418.688.3001
[cid:image001.gif at 01D1BB3B.06299CB0]<http://www.innovmetric.com/>
AVIS DE CONFIDENTIALITÉ/CONFIDENTIALITY NOTICE: Ce message peut contenir des renseignements confidentiels appartenant exclusivement à InnovMetric Logiciels inc. ou à ses filiales. Si vous n'êtes pas le destinataire indiqué dans ce message (ou responsable de livrer ce message à la personne indiquée ou prévue) ou si vous pensez que ce message vous a été adressé par erreur, vous ne pouvez pas utiliser ou reproduire ce message, ni le livrer à quelqu'un d'autre. Dans ce cas, veuillez le retourner à l'expéditeur et le détruire. Proprietary confidential information belonging to InnovMetric Software Inc. and its affiliates may be contained in this message. If you are not a recipient indicated or intended in this message (or responsible for delivering this message to such a person), or you think for any reason that this message may have been addressed to you by mistake, you may not use or copy this message, or deliver it to anyone else. In which case, notify the sender and destroy the e-mail.



More information about the Framers mailing list