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

[Bernard Aschwanden (Publishing Smarter)]

I'll chime in to say that in almost every case where people create content,
it should be done with the audience in mind. Unless the audience knows
"exemplified" it's likely best to stick to ideas other people have
suggested.

 

Simpler is often better. It's becoming more and more common for people who
read content to have a background that may not be "English first". That's a
good reason to stick to words they know best. The content we create isn't
(or generally *shouldn't*) be a way to show how clever we are with words,
but rather how clever we are with making people not even think about the
words and instead help them achieve their goals with no obstacles.

 

Want to be clever with words? Go do this awesome work (anyone able to rework
it, with all the punctuation, and in ANY way tie that to FrameMaker?)

 

Micah Lexier + Christian Bok

 

:-)

 

 

Bernard

 

 

 

-----Original Message-----
From: Framers
[mailto:framers-bounces+bernard=publishingsmarter.com at lists.frameusers.com]
On Behalf Of Syed Zaeem Hosain
Sent: May 31, 2016 1:50 PM
To: Stephen O'Brien; Frame Users (framers at lists.frameusers.com)
Subject: Re: [Framers] "Exemplified" - use in technical documentation?

 

"Exemplified" implies more than "shown in" ... it also has connotations of
"this is a better way". 

 

Unless that was the intention (i.e., emphasizing the "better way"), when
pointing to a figure or diagram, this is unnecessary and almost a tiny bit
arrogant.

 

Consider using a more active voice perhaps: "Figure X.X shows ..."

 

Z

 

> -----Original Message-----

> From: Framers [mailto:framers-

>  <mailto:bounces+syed.hosain=aeris.net at lists.frameusers.com>
bounces+syed.hosain=aeris.net at lists.frameusers.com] On Behalf Of

> Stephen O'Brien

> Sent: Tuesday, May 31, 2016 09:51 AM

> To: Frame Users ( <mailto:framers at lists.frameusers.com>
framers at lists.frameusers.com) 

> < <mailto:framers at lists.frameusers.com> 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?

_______________________________________________

 

This message is from the Framers mailing list

 

Send messages to  <mailto:framers at lists.frameusers.com>
framers at lists.frameusers.com Visit the list's homepage at
<http://www.frameusers.com> http://www.frameusers.com Archives located at
<http://www.mail-archive.com/framers%40lists.frameusers.com/>
http://www.mail-archive.com/framers%40lists.frameusers.com/

Subscribe and unsubscribe at
<http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com>
http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com

Send administrative questions to  <mailto:listadmin at frameusers.com>
listadmin at frameusers.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: image/jpeg
Size: 87464 bytes
Desc: not available
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20160531/561cbca4/attachment.jpeg>