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: Lingua Franca Today From:Andrew Plato <intrepid_es -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 14 Jan 2002 20:24:05 -0800 (PST)
I am sure you meant well, but I think it is inappropriate to be using
flowery language like "Lingua Franca" in a technical document. The point
of technical communications is not to demonstrate that you CAN use big
words, its to communicate complex ideas using SIMPLE language.
> i use words like lingua franca because that's what we get paid to do.
Maybe your company has different standards, but technical writers by an
large are not paid to inject flowery words into technical manuals. And I
am sorry, but "lingua franca" is pretty darn flowery.
> like you, andrew, i tend to gear my writing toward the
> particular client.
Well, maybe your client likes that kind of language. But the fact that 1
of 3 readers questioned your choice, shows that 1/3rd of your readers
didn't get it. Assuming you had 10,000 customers, a full 3000 of them
would have had the same problem.
I don't know many firms that are willing to alienate 1/3 of their
customers so they can use flowery words.
> i wrote: "routers speak BGP to one another in order to move network
> traffic without losing it."
>
> perhaps it would be less confusing to you and others were i to write:
"in
> order to move network traffic without losing it, routers speak BGP to on
> another."
>
> or, "routers, in order to move network traffic without losing it, speak
BGP
> to one another."
> i'm hard pressed to see how the first sentence conveys the notion that
BGP
> moves information.
The inaccuracy is one of nuance. The way you wrote it, it sounds like BGP
is moving traffic from here to there. It isn't. All BGP does is help
routers configure their routing tables so they CAN route traffic better.
The transport side of this is incidental.
A more appropriate way to say this might be:
"The border gateway protocol (BGP) is a critical component of the
Internet's routing infrastructure. It allows routers to exchange routing
information regardless of the router manufacturer. Using the BGP protocol,
routers can share "maps" of their network with other routers. This allows
for more efficient and error-free routing of network traffic."
> It seems clear that the router moves information.
> (context matters, of course. the preceding section contained a
discussion
> of what routers are and do. they now know that routers move information.
> they are learning that BGP is a common language that helps routers from
> different manufacturers move this information.)
> perhaps an ace sentence diagrammer could settle it? :) i'm guessing
that,
> like me, this isn't your strong suit since you confuse "your" for
"you're"
> and "of" for "have".
This isn't a sentence diagramming problem, its a technical one. Flowery
language and dumbed-down text can obfuscate the complexities of
technologies. Either you teach people how things really work, or don't
teach them at all.
Andrew Plato
__________________________________________________
Do You Yahoo!?
Send FREE video emails in Yahoo! Mail! http://promo.yahoo.com/videomail/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for FREE, through January 15th. RoboHelp can import your existing
Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr
---
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.