Previous in Forum: AC Motor   Next in Forum: Should You Play Powerball? Science Solves The Mystery
Close
Close
Close
37 comments
Rate Comments: Nested
Power-User

Join Date: Nov 2015
Posts: 335

Tips in Writing Short Article

01/13/2016 6:26 PM

Hi guys, any tips on writing a short technology article? I know there are veterans in this field down here.

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
Pathfinder Tags: Technical Article Writing
Interested in this topic? By joining CR4 you can "subscribe" to
this discussion and receive notification when new comments are added.

Good Answers:

These comments received enough positive votes to make them "good answers".

"Almost" Good Answers:

Check out these comments that don't yet have enough votes to be "official" good answers and, if you agree with them, vote them!
Power-User
Hobbies - Musician - New Member Technical Fields - Technical Writing - New Member

Join Date: Nov 2012
Posts: 431
Good Answers: 6
#1

Re: Tips in writing short article

01/13/2016 6:40 PM

Not knowing anything about the article or situation, I'd say: Be direct and concise. Not verbose. And, borrowing from Mark Twain, never ever use "very."

__________________
Nobody realizes that some people expend tremendous energy merely to be normal. -Camus
Register to Reply
4
Guru

Join Date: Mar 2007
Location: by the beach in Florida
Posts: 33392
Good Answers: 1817
#2

Re: Tips in Writing Short Article

01/13/2016 6:57 PM

The secret to writing is rewriting...Just write out everything you need to say first, then edit and rewrite it until it reads smoothly and covers all the info needed....Pictures illustrating ideas are useful in some situations....and you must be well researched on the subject....try not to repeat words used for descriptive purposes...

__________________
All living things seek to control their own destiny....this is the purpose of life
Register to Reply Good Answer (Score 4)
3
Guru

Join Date: Aug 2014
Location: Port Macquarie N.S.W. Australia
Posts: 1071
Good Answers: 225
#5
In reply to #2

Re: Tips in Writing Short Article

01/13/2016 7:38 PM

As SE has stated, then check, recheck, and recheck again your spelling and grammar.

Nothing turns a reader off more rapidly than having to try to interpret what you are trying to say due to lack of/poorly placed commas and apostrophes, sentences that are too long or fragmented, Paragraphs not correctly used to subdivide the topics, incorrect words used - eg. Paronyms, Homophones, etc.

Get it right, ask someone who is a good speller and grammatist but who hasn't a clue about the subject to read it and tell you where it causes them problems in understanding the meaning of what you are saying rather than the actual content.

Then review it again yourself.

Register to Reply Good Answer (Score 3)
Guru

Join Date: Apr 2015
Location: NYC until mid 2015, currently NC
Posts: 756
Good Answers: 8
#25
In reply to #5

Re: Tips in Writing Short Article

01/15/2016 1:38 AM

Avoid using jargon, you never know the expertise and familiarity of the person reading the report or article, with the subject. It may be just an engineering manager, or some company executive.

Also be sure to indicate the full name of any organization, process, material or system to which you will be referring before using the initials or acronym, e.g. National Fire Protection Association (NFPA), sludge dewatering (SDW), Liquefied Natural Gas (LNG) or Invitro Fertilization (IVF) or Microsoft Disc Operating System (MS-DOS).

The full names should be mentioned at least one before using initials, and for those titles that are not too common outside a specialized field, at least once at the start of each page. An alternative is to provide a sheet listing all abbreviations and acronyms used in the report, but the full name should be noted at least at the first occurrence.

Nothing is more annoying than reading a well written report or article, and having to continually refer to an earlier page to understand what the author is talking about when using a certain abbreviation.

__________________
Good judgment comes from experience, and a lotta that comes from bad judgment.
Register to Reply Score 1 for Good Answer
Power-User

Join Date: Nov 2015
Posts: 335
#16
In reply to #2

Re: Tips in Writing Short Article

01/14/2016 11:46 AM

Do you have any idea, how much a web article of 300 words would cost? Say, if you are the one writing it, what is your bill for it? Forgive me, I am new at this. I do not know if my bid was under value.

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
Guru
Engineering Fields - Electrical Engineering - Been there, done that. Engineering Fields - Control Engineering - New Member

Join Date: Dec 2008
Location: Long Island NY
Posts: 15600
Good Answers: 981
#17
In reply to #16

Re: Tips in Writing Short Article

01/14/2016 12:11 PM

Now you're exploring the realm of marketing. A product, any product, is worth only what the market is willing to pay for that product. You are new to this field, the idea that you're offered any money for your efforts should be gladly taken as an ego boost.

__________________
"Don't disturb my circles." translation of Archimedes last words
Register to Reply
Power-User

Join Date: Nov 2015
Posts: 335
#18
In reply to #17

Re: Tips in Writing Short Article

01/14/2016 12:45 PM

Okay, that's nice to see.

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
Guru
Engineering Fields - Electrical Engineering - Been there, done that. Engineering Fields - Control Engineering - New Member

Join Date: Dec 2008
Location: Long Island NY
Posts: 15600
Good Answers: 981
#19
In reply to #18

Re: Tips in Writing Short Article

01/14/2016 6:56 PM

Don't get me wrong. I congratulate you for getting paid for a short article. As you slowly build a reputation, you can also slowly raise your fees.

__________________
"Don't disturb my circles." translation of Archimedes last words
Register to Reply
Power-User

Join Date: Nov 2015
Posts: 335
#32
In reply to #19

Re: Tips in Writing Short Article

01/15/2016 9:25 PM

A' that's more like it. I got the idea Red, thank you.

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
Guru

Join Date: Apr 2015
Location: NYC until mid 2015, currently NC
Posts: 756
Good Answers: 8
#23
In reply to #2

Re: Tips in Writing Short Article

01/15/2016 12:41 AM

As for rewriting, you are absolutely correct, unless there is some time constraint (procrastination does not count) that does not allow for it.

With the exception of reports required upon completion of an inspection or investigation, I found it a good practice to put the report or article aside for a day (usually in my desk); upon rereading what I thought the previous day was a perfect report or article, many errors in spelling, grammar or description of an incident, or operation were obvious.

Your suggestion not to repeat words for descriptive purposes is well taken, but there will be times when only certain wording is is accurate, and while continued reuse of certain wording should be avoided, the writer should not be afraid to reuse a word if no other word will accurately describe a particular item or operation.

(If you find mistakes in this response it's because I didn't put it in my desk overnight)

__________________
Good judgment comes from experience, and a lotta that comes from bad judgment.
Register to Reply
2
Guru

Join Date: Jan 2006
Location: Tamworth, UK.
Posts: 1782
Good Answers: 45
#27
In reply to #23

Re: Tips in Writing Short Article

01/15/2016 8:50 AM

Generally good advice all round here - but there is a presumption that you know what you are talking about when you write an article.

That aside, a bit like me, I am forever rewriting and correcting articles as I go (the curse of word processors - that never occurred with a typewriter - except for Tippex).

Even then errors slip through because I proof read what I 'wrote', as opposed to reading what I typed. Leaving articles until the next helps me 'forget' what I wrote - and I have to remind myself by reading what I typed - hence picking up spelling and grammar mistakes. Unfortunately, time scales seldom permit delays - and the first I know of my mistakes is when I read the 'published' article - as often happens to me on CR4.

But whatever the technique in terms of the mechanism for getting an article published - you have to use the language of your audience - both in 'tongue' and 'technical' words - obvious when you think about it - but easy to forget when engrossed in constructing the article.

Going OT a little, I am bemused by 'articles' accompanying advertisements seeking applicants for jobs - where for instance - '..fluent German absolutely essential...' with the ad written in English. Why not German if that important?

But whatever 'language' used - avoid like the plague solid blocks of text in small fonts - and if including pictures essential to the plot at that instant then make sure they are on the same page - there is nothing more annoying than having to turn pages to find pictures - then gettings 'lost' when returning to the text.

Actually this is an irritating feature with CR4. You click on a previous number to find out what the reply is about - then get lost because there is no 'return' feature to get you back.

Such is life!

__________________
When arguing, remember mud-slinging = lost ground.
Register to Reply Good Answer (Score 2)
Power-User

Join Date: Mar 2014
Posts: 204
Good Answers: 3
#37
In reply to #27

Re: Tips in Writing Short Article

01/20/2016 12:36 AM

It would be nice to have a posting number table available

Register to Reply
3
Guru
Engineering Fields - Electrical Engineering - Been there, done that. Engineering Fields - Control Engineering - New Member

Join Date: Dec 2008
Location: Long Island NY
Posts: 15600
Good Answers: 981
#3

Re: Tips in Writing Short Article

01/13/2016 7:24 PM

Know your audience.

__________________
"Don't disturb my circles." translation of Archimedes last words
Register to Reply Good Answer (Score 3)
5
Guru
Technical Fields - Technical Writing - New Member Engineering Fields - Piping Design Engineering - New Member

Join Date: May 2009
Location: Richland, WA, USA
Posts: 21017
Good Answers: 795
#4

Re: Tips in Writing Short Article

01/13/2016 7:36 PM

There is kind of a standby "formula" of:
1. Tell them what you are going to tell them. (Define terms, brief overview.)
2. Tell them. (The meat of your article, filling in the details.)
3. Tell them what you told them. (Brief recap.)

__________________
In vino veritas; in cervisia carmen; in aqua E. coli.
Register to Reply Good Answer (Score 5)
2
Guru
Engineering Fields - Optical Engineering - Member Engineering Fields - Engineering Physics - Member Engineering Fields - Systems Engineering - Member

Join Date: Apr 2010
Location: Trantor
Posts: 5363
Good Answers: 647
#7
In reply to #4

Re: Tips in Writing Short Article

01/13/2016 9:32 PM

Yes. This is often the 'formula' for giving a speech, but it applies as well to technical writing.

One of the most annoying problems of most writers is that they don't define their terminology at the beginning of the articles they write. They use too many acronyms, for example, without explaining what the acronyms stands for.

I've done lots of technical writing over the years. I would add this to what Tornado said:

Don't bury the 'lede'. Your first paragraph needs to tell your reader what the article is about.

Avoid jargon. Write conversationally. Imagine you are explaining the subject to a friend.

Use simple declarative sentences, which means avoid using the subjunctive tense.

Keep the sentences short, and keep the paragraphs short. Paragraphs should be at least 2 sentences long, and no more than 6 sentences long. If you occassionally feel the need to use a long sentence, try to break it into two sentence segments connected with a semi-colon; semi-colons can be very useful.

And finally, recite the article in your head after the first draft. Be aware that there is a major difference between "Let's eat grandma!" and "Let's eat, grandma!"

__________________
Whiskey, women -- and astrophysics. Because sometimes a problem can't be solved with just whiskey and women.
Register to Reply Good Answer (Score 2)
Guru
Popular Science - Evolution - New Member Popular Science - Weaponology - New Member

Join Date: May 2006
Location: The 'Space Coast', USA
Posts: 11119
Good Answers: 918
#6

Re: Tips in Writing Short Article

01/13/2016 7:58 PM

Lord!

Can you provide more information?

What is the subject?

This is a non-fiction, I take it?

How many words?

Who is the intended audience?

Have you published before?

Let's start with that.

Register to Reply
Power-User

Join Date: Nov 2015
Posts: 335
#9
In reply to #6

Re: Tips in Writing Short Article

01/13/2016 10:50 PM

God bless you AP.

Subject was Green Technology, non-fictional articles.

Audience is all sorts from the web.

Published once a research paper.

I assumed this job is quite a different approach, so I asked points to consider when writing from the CR4 experts of course.

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
Guru
Popular Science - Evolution - New Member Popular Science - Weaponology - New Member

Join Date: May 2006
Location: The 'Space Coast', USA
Posts: 11119
Good Answers: 918
#12
In reply to #9

Re: Tips in Writing Short Article

01/14/2016 7:32 AM

Is this a paid submittal?

The process should be the same. Create an outline of the work. Get your references together. Write the first draft. Rewrite until it is polished.

Make sure any and all arguments are answered and backed up in a logical progression.

Now, you need an independent set of eyes to review your work. Best to not ask friends. They will only give you a glowing report. You need someone in the know that can critique your work. There are paid organizations that you can hire, but you might find someone that will do it for free or as a trade to review their work.

Make final adjustments and send to the editor to be published. They may kick it back with further recommendations or they may reject it. I don't know the end user here or how critical they are. However, that is the basic nuts and bolts.

Register to Reply
Power-User

Join Date: Nov 2015
Posts: 335
#33
In reply to #12

Re: Tips in Writing Short Article

01/15/2016 9:33 PM

Yes, it's a paid submittal. Thanks AH.

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
Power-User

Join Date: Nov 2015
Posts: 335
#8

Re: Tips in Writing Short Article

01/13/2016 10:45 PM

Wow, what more could I ask. As I read from post#1 til the end, I feel like getting smaller and smaller, but I really thank you guys for wrapping it up for me.

I felt like a babe after reading all your comments, but it is a good day to start. Thank you all.

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply Score 1 for Good Answer
2
Guru
Popular Science - Weaponology - New Member United Kingdom - Member - New Member

Join Date: May 2007
Location: Harlow England
Posts: 16512
Good Answers: 670
#10

Re: Tips in Writing Short Article

01/14/2016 2:24 AM

Some great advice already.

Decide on your style, informal and witty, business like and formal.
Get someone you trust to proof read it, that can help a lot.
People have a short attention span and want to get to the point, so keep introduction and summaries brief, else they cease to be summaries.

Re write it, because the act of writing it reminds you of stuff that maybe shouldn't have been at the end, so needs putting in the intro.
Like this "Hi Mr Small"

I've just been doing some bow making videos and due to the V long download time have been ruthless with the editing... the videos are all the better for it.
Del

PS. Anyone wanting to see my videos get on Youtube and search for "Yew ELB"
its a 10 part series going from a quarter log to a finished bow being shot. Each is only about a minute or two long except the last which is about 9 mins

__________________
health warning: These posts may contain traces of nut.
Register to Reply Good Answer (Score 2)
Guru
Popular Science - Evolution - New Member Popular Science - Weaponology - New Member

Join Date: May 2006
Location: The 'Space Coast', USA
Posts: 11119
Good Answers: 918
#13
In reply to #10

Re: Tips in Writing Short Article

01/14/2016 7:35 AM

Yes, and just like the fiction author Steven King says - kill your darlings!

You need to be ruthless when editing and rewriting your work. What seems cute and clever to you often is not.

Register to Reply
Power-User

Join Date: Nov 2015
Posts: 335
#15
In reply to #10

Re: Tips in Writing Short Article

01/14/2016 10:48 AM

Hi, Del!-geez.. I bet you're still making bow. Relay my best regards to Kris. Will you?

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
Guru
United Kingdom - Member - Indeterminate Engineering Fields - Control Engineering - New Member

Join Date: Jan 2007
Location: In the bothy, 7 chains down the line from Dodman's Lane level crossing, in the nation formerly known as Great Britain. Kettle's on.
Posts: 32175
Good Answers: 839
#11

Re: Tips in Writing Short Article

01/14/2016 6:51 AM

The shortest article in the English language, is "A".

__________________
"Did you get my e-mail?" - "The biggest problem in communication is the illusion that it has taken place" - George Bernard Shaw, 1856
Register to Reply
Guru
Technical Fields - Project Managers & Project Engineers - New Member

Join Date: Oct 2013
Location: Texas.Baytown
Posts: 697
Good Answers: 26
#14

Re: Tips in Writing Short Article

01/14/2016 9:54 AM

I have to write technical reports to management a great deal. I have learned to be precise, brief and never use abbreviations.

1. Give a title.

2. Give a reason for the report.

3. Give the report in as few words as possible.

4. Give a conclusion.

__________________
If you want to know how well a broom works you do not ask the guy selling the broom or the guy who designed the broom, you ask the guy using the broom.
Register to Reply Score 1 for Good Answer
Guru
United States - Member - New Member Popular Science - Cosmology - New Member Technical Fields - Education - New Member

Join Date: Jan 2014
Location: Albany, NY
Posts: 1187
Good Answers: 24
#20

Re: Tips in Writing Short Article

01/14/2016 8:55 PM

The advice our esteemed CR4 community has offered is really excellent -- no surprise there. I have a suggestion that's more long-term, in case you decide you like writing and want to keep at it: read as much as you can and keep copies, virtual or hard, of the articles that exemplify good writing. And the ones you from which you learned sod all. Check the articles in relevant Engineering 360 newsletters as well as feature articles on our site for examples.

And enjoy the process ... I like writing but being extremely ADD I will do anything except sit down to write, including polishing the silver or cleaning out closets.

Register to Reply
Power-User

Join Date: Nov 2015
Posts: 335
#34
In reply to #20

Re: Tips in Writing Short Article

01/16/2016 7:41 AM

That's funny of you. Yes, I did subscribe. Thank you BestInShow..God bless you!

__________________
"And ye shall seek me, and find me, when ye shall search for me with all your heart."
Register to Reply
2
Guru

Join Date: May 2006
Location: Placerville, CA (38° 45N, 120° 47'W)
Posts: 6215
Good Answers: 248
#21

Re: Tips in Writing Short Article

01/15/2016 12:18 AM

After all the excellent advice above, one more item: If you use any acronyms, make sure you spell each one out on the first occurrence (Full Words with the Significant Letters Capitalized)

__________________
Teaching is a great experience, but there is no better teacher than experience.
Register to Reply Good Answer (Score 2)
Guru

Join Date: May 2006
Location: Placerville, CA (38° 45N, 120° 47'W)
Posts: 6215
Good Answers: 248
#35
In reply to #21

Re: Tips in Writing Short Article

01/16/2016 10:27 AM

...and one more thing that probably won't apply: If you will be writing the article in a language that is not your original native language, find someone with some technical knowledge in the field and whose native language is the one being used, to review and critique the article before sending it to the publisher.

__________________
Teaching is a great experience, but there is no better teacher than experience.
Register to Reply
Power-User

Join Date: Mar 2014
Posts: 204
Good Answers: 3
#22

Re: Tips in Writing Short Article

01/15/2016 12:40 AM

In addition to the good stuff above I would add : avoid using multiple terms that mean the same thing.

Some big-time tech literature (eg.MS) is written in this compulsively cute and puffed-up style. The result for those not bamboozled is pure turn-off.

You could always message your final draft to me. I would be pleased to critique it to shreds.

Register to Reply
Power-User

Join Date: Jul 2008
Location: Adelaide, Australia
Posts: 403
Good Answers: 14
#24

Re: Tips in Writing Short Article

01/15/2016 12:58 AM

Technical papers are normally unbelievably dull.

Follow the style of newspaper journalists, write a precis or executive summary of the article at the beginning, then expand the detail.

You have a short time to get the readers interest, so don't waste it talking about you, that can go at the end. One suggestion is to write it then delete the first paragraph, the remainder will often be more interesting without it.

Tony

__________________
The nice thing about Standards is there are so many to choose from.
Register to Reply
Power-User

Join Date: Mar 2014
Posts: 204
Good Answers: 3
#26

Re: Tips in Writing Short Article

01/15/2016 1:56 AM

Technical papers are normally unbelievably dull.

Exactly.

So shoot for clarity and conciseness. The effort you spare the reader will not go unappreciated.

Register to Reply Score 1 for Good Answer
Guru
Technical Fields - Project Managers & Project Engineers - New Member

Join Date: Jun 2014
Posts: 623
Good Answers: 33
#28

Re: Tips in Writing Short Article

01/15/2016 9:13 AM

There are a ton of resources on the web. And the good ones will follow the OP, TT, RP format using consistent words for the things you are talking about, once you name something, use that name throughout your paper.

OP = Operational Purpose

TT - Technical Task

RP = Rhetorical Purpose

__________________
Hey Isaac, catch! ...oops, that's gonna leave a mark...
Register to Reply
Member

Join Date: Dec 2015
Location: Michigan
Posts: 8
#29

Re: Tips in Writing Short Article

01/15/2016 9:50 AM

Great advice.

Also, start with an Outline, a list of points you want to make.

1.

2.

3.

Put those in an order that makes sense.

Lastly expand on those points just enough to get your idea across.

As someone else said... write it like you are talking to a friend (visualize that friend) who knows nothing about the subject.

Fun and Easy!

__________________
Just DO It
Register to Reply
Guru
Engineering Fields - Instrumentation Engineering - New Member Hobbies - Automotive Performance - New Member Technical Fields - Education - New Member Fans of Old Computers - TRS-80 - New Member Hobbies - Musician - New Member

Join Date: Jan 2008
Location: Tucson, AZ
Posts: 1331
Good Answers: 30
#30

Re: Tips in Writing Short Article

01/15/2016 12:31 PM

Might I add: "Author, know your reading audience!"

__________________
...and the Devil said: "...yes, but it's a DRY heat..!"
Register to Reply
3
Guru

Join Date: Jul 2006
Location: Eastern Kansas USA
Posts: 1503
Good Answers: 128
#31

Re: Tips in Writing Short Article

01/15/2016 8:01 PM

Mr. Small,

Your topic is one with a wide divergence of opinion and "information".

  • Know the level of expertise and interest in your audience (if possible).
  • Be prepared for people's attacking you at all sorts of levels.
  • If you believe something in your article may be controversial or questioned, be ready with documentation for your source AND be sure that your source is reliable/reputable/etc. In your topic area, as well as many others, there are many loud voices with good-sounding names but with very poor science.
  • Read your resources carefully to see if they are blinded by assumptions, poor design, faulty procedures, financial conflicts, etc.
  • Don't write like an engineer!

--JMM

Register to Reply Good Answer (Score 3)
Guru

Join Date: Jan 2006
Location: Tamworth, UK.
Posts: 1782
Good Answers: 45
#36
In reply to #31

Re: Tips in Writing Short Article

01/16/2016 9:14 PM

To Jmueller #31

Worth a GA for readers involved in articles to convey ideas to influence small audiences of diverse interests.

In my case I say this based on my experience with committee work to produce technical standards by consensus for BSI, CEN and ISO in my specialist field.

Committees are made up of members with expert knowledge in their own field who rely on your expertise to present a sound technical argument in your field where it affects them. Some might also be experts in your field but with a commercial interest - declared formally on record - but often working to their own secret agenda - where they use all the tricks of debate to win their case - especially if they oppose you.

So thoroughly researched technical presentations are essential - and have to be presented to address technical matters at expert level but also written without jargon to impart important information to novices in your field where English is probably not their first language - because the latter are likely to support you if convinced by your argument - particularly in writing so they can take the matter back to their supporting organisations or counties for review by their own experts - who in fact might know more than you - which for practical reasons requires a counterargument if your views are challenged.

Watch out if you are a lone voice here, because interpreting 'consensus' to mean 'majority' and thus use it to dismiss minority opposing views (to keep them out of the Minutes) is a favourite trick of your opponents.

Sound technical arguments usually carry the day. But, and it is a big but, it is essential for the matter to be properly written up and recorded in the Minutes.

Clearly, briefly and to the point - which should result from following the good advice pesented here by CR4 members.

__________________
When arguing, remember mud-slinging = lost ground.
Register to Reply Score 1 for Good Answer
Register to Reply 37 comments

Good Answers:

These comments received enough positive votes to make them "good answers".

"Almost" Good Answers:

Check out these comments that don't yet have enough votes to be "official" good answers and, if you agree with them, vote them!
Copy to Clipboard

Users who posted comments:

70AARCuda (1); Anonymous Hero (3); BestInShow (1); Casper71 (2); dkwarner (2); Hannes (1); horace40 (2); jmueller (1); Massey (1); Mr. small (8); PWSlack (1); redfred (3); SolarEagle (1); spades (1); SteeleMcCoy (1); texasron (1); Tonymech (1); Tornado (1); Usbport (1); user-deleted-1105 (1); zzorb (3)

Previous in Forum: AC Motor   Next in Forum: Should You Play Powerball? Science Solves The Mystery

Advertisement