Technical Writing Punctuation

technical writing punctuation"technical writing punctuation"

Technical Writing Tips - Best Ways to Write Article Clearly

Most people can write very clearly if they know what they are trying to say. If your article is well planned, it should not be difficult to write.

When writing the first draft, do not worry about spelling, punctuation, or precise wording. Just get everything down on paper. Then go back and improve the organization and wording. Finally, once all the information is in place and clearly presented, check spelling, punctuation, and grammar.

Write as simply as possible. Your subject matter is complicated enough on its own merits; your task is to make it clear, not obscure. Use short words.

When you are explaining anything, ask yourself what the reader wants to know, and make the answers to those questions prominent. (Imagine a FAQ file about your subject; what would be in it?) Don't simply write down all the information you want to present in an arbitrary order (or even in a well-organized order that doesn't put the emphasis on the reader's needs).

You can improve your explanations by getting other people to read your paper and insisting that they tell you whenever they find it obscure. Make sure all of the steps in your logic are clearly presented and that you create a clear image in the reader's mind.

Formal notations (formulas, program listings, etc.) do not speak for them-selves. They must be accompanied by plain-English explanations of how the formula or program contributes to your point.

At the same time, don't try to translate Prolog or algebra into English. When you need listings or formulas, use them.

Divide the paper into sections with section titles. Tell the reader how you are organizing your work: "This section will review previous results... There are three important results from earlier work... First... Second... Third..."

Say "I" if you mean "I." That is, do not call yourself "the present author" or use other awkward phrases. On the other hand, do not write about your personal experiences when you are supposed to be writing about your subject. Experiments are usually described by saying what was done, not who did it, because it doesn't matter who did it.

Notice the large number of one- and two-syllable words in this guide; emulate it. Do not imitate most of the scientific papers you read; they are not particularly well-written.

About the Author

Alim has been writing articles online for nearly 3 years.  Check out his latest reviews on <a target="_new" href="http://womensraincoatshop.com/"> Raincoats For Women </a>  and <a target="_new" href="http://womensraincoatshop.com/winter-coats/"> Winter Coats For Women </a>

Shamrock Editing Services


technical writing punctuation
technical writing punctuation