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

Peter Hirons peter at galley.ie
Tue May 31 10:00:43 PDT 2016


Get rid of it - it's just pompous writing.  Especially important if your 
documents go to non-native-English speakers.

"Shown in" is universally understood. "Illustrated in" less so.

---


Peter

On 2016-05-31 17:50, Stephen O'Brien wrote:
> 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.
> 
> 
> _______________________________________________
> 
> This message is from the Framers mailing list
> 
> Send messages to framers at lists.frameusers.com
> Visit the list's homepage at  http://www.frameusers.com
> Archives located at 
> http://www.mail-archive.com/framers%40lists.frameusers.com/
> Subscribe and unsubscribe at
> http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com
> Send administrative questions to listadmin at frameusers.com


More information about the Framers mailing list