RE: Six elementary rules for writing good english

["Lauren" <lt34 -at- csus -dot- edu>]

Hey Mark,

I you are saying that you write scientific terms when you cannot think of an
everyday English equivalent, then you are not contradicting the rule.  An
everyday English equivalent that is not used by the audience of the document
is not exactly an "equivalent" because it will not function as an equal
term.  However, even scientific technical documents should be written for
the everyday person with the appropriate scientific background to
understand, so terms should be appropriately defined when they are used.  

Also, I think that in this case, Rule #5, "jargon" is getting the same
treatment as colloquilism.  Although, there are certain terms that people
use in everyday speech and informal writing, formal documentation needs use
clear, non-casual terms and avoid the use of jargon or colloquialism.

Lauren
 

> -----Original Message-----
> From: techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com 
> [mailto:techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com] On 
> Behalf Of Mark the Writer
> Sent: Monday, August 06, 2007 8:26 AM
> To: 'techwr-l'
> Subject: RE: Six elementary rules for writing good english
> 
> 
> RE:  George Orwell ("Politics and the English Language", 1946)
> 
> >From "The Economist"
> 
> 5. Never use a foreign phrase, a scientific word or a jargon 
> word if you can
> think of an everyday English equivalent.
> 
> ******
> 
> Find rule 5 hard to follow for technical writing.
> 
> As an engineer myself - you use the scientific terms and 
> jargon that all of
> the engineers use in person and in documents.
> 
> Not some non-engineer equivalent.
> 
> When the engineers see a technical document that does not use 
> established
> technical wording - they have some very 
> choice things to say to me about the tech writers who do.
> 
> Do not forget the other golden rule for technical or 
> non-technical documents
> - write for the audience.
> 
> Mark
> mdbinc.com
> 
> 
> 
> 
> -- 
> No virus found in this outgoing message.
> Checked by AVG. 
> Version: 7.5.476 / Virus Database: 269.11.6/938 - Release 
> Date: 8/5/2007 4:16 PM
> 
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> Create HTML or Microsoft Word content and convert to Help 
> file formats or 
> printed documentation. Features include support for Windows 
> Vista & 2007 
> Microsoft Office, team authoring, plus more.
> http://www.DocToHelp.com/TechwrlList
> 
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
> 
> ---
> You are currently subscribed to TECHWR-L as lt34 -at- csus -dot- edu -dot- 
> 
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit 
> http://lists.techwr-l.com/mailman/options/techwr-l/lt34%40csus.edu
> 
> 
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
> 
> Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
> http://www.techwr-l.com/ for more resources and info.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.