Tuesday 11 June 2019

Writing Scientific Articles

Steps in Paper Writing 
  1. Pre-writing (content dump) - 70%
  2. Writing - 10%
  3. Revision (rewriting, formatting) - 20%
STYLE - The following tips are helpful to maintain a good style of writing.
  1. Cut the clutter
    1. Remove clunky words/phrases - important, as it is well know that, and it should be emphasized that
    2. Remove hedge words - e.g. very and appreciable
    3. Remove unnecessary jargons and acronyms. 
    4. Remove repetitive words/phrases. 
    5. Eliminate negatives. 
    6. Omit needless prepositions - e.g. that
    7. Use adverbs sparingly - e.g. really, basically, and generally
    8. Shorten long words and phrases - e.g. due to the fact that to because
  2. Use the active voice
  3. Write with verbs - Use strong verbs. Don't turn verbs into nouns. Don't bury the main verb
Good Style, John Kirkman - A writer should aim for accuracy, clarity, readability and the right tone in scientific and technical writing.
  1. Sentences - Sentences should be reasonably short and not too complex. In order to rearrange sentences, use compound sentence structures and complex sentence structures. 
  2. Vocabulary 
    1. In general, prefer short words to long words, ordinary words to grand words, familiar words to unfamiliar words, non-technical words to technical words and concrete words to abstract words.
    2. Use jargons only if they are genuinely necessary.
    3. Avoid fashionable words such as functionality, enhance (improve/increase?), parameter (value/variable?), peripheral, viable or inhibit (stop/reduce?) because they have become unreliable units of information exchange. 
  3. Phrases 
    1. Avoid roundabout phrasings that uses abstraction or nominalization. Avoid abstraction by being as being as specific as possible. Avoid nominalization, thereby getting rid of colorless verbs such as achieve, perform, accomplish, carry out, conduct, observe 
    2. Avoid unusual phrasings that use words such as having and being
    3. Avoid excessive use of adjectives as premodifiers. Usually, one or two adjectives, especially number adjectives and color adjectives, come before the noun, and other modifiers come after it. 
    4. Avoid excessive use of nouns as premodifiers. Premodifying nouns are less explicit than postmodifying prepositional constructions. Confusion may also arise when nouns are used as premodifiers along with prepositions, transitive verbs, and to be and to become. The trick is to introduce the agent as soon as possible. 
  4. Verbs 
    1. Tense - Use past tense to state what the objectives were, what equipments were used and what procedures were used. Use present tense to state ‘eternal truths’ and in discussions of data or results. 
    2. Voice - Use a proper mixture of active and passive voice. Use active voice as far as possible. Use passive voice only when the agent is unimportant, when the agent is not known, when we do not want to state who the agent is and while stating a generally-held belief. Improper use of passive voice can lead to distortion in meaning, roundabout phrasing and ambiguity. Active writing does not have to be personal. It may be desirable to ensure objectivity in scientific and technical writing, but not at the cost of clarity. Avoid it...that constructions. 
  5. Punctuation
    1. Use right punctuation at the right places. Punctuations are an integral part of written communication.
    2. Add comma after discourse markers such as however, well, since, ... 
  6. Tone - Avoid cheap attempts at producing user-friendly text that may come across to the reader as overly-patronizing. A comfortable, conversational user-friendly tone is best produced by use of simple vocabulary in direct address to the user.
  1. Don’t wait, just start writing - forces us to be clear and focused; open the way to initiate dialogue with others; a way to develop ideas, instead of an output medium 
  2. Identify your key idea - a paper is an idea-conveying mechanism; the paper should have exactly one clear, sharp idea; “the main idea of this paper is...”, “in this section we present the main contributions of the paper.”  
  3. Tell a story
    1. narrative flow: (1) here is a problem, (2) it is an interesting problem, (3) it is an unsolved problem, (4) here is my idea, (5) my idea works, (6) here’s how my idea compares to other people’s approaches
    2. structure: (1) title, (2) abstract, (3) introduction, (4) the problem, (5) my idea, (6) the details, (7) related work, (8) conclusions and future works 
  4. Nail your contributions to the mast - first page of the paper is very important; describe the problem and state your contributions; use an example; idea vs. contribution; 
  5. Related work - put it at the end of the paper; explain your idea first, along with details and then compare to existing work; acknowledge weaknesses in your approach; be generous to the competition; 
  6. Put your readers first - use examples, figures well
  7. Listen to your readers - internal review; experts and non-experts; use the guinea pigs carefully; “just put one mark where you get lost and then we’ll talk about it”;  
PARAGRAPHING

The three important elements of successful academic writing are punctuation, paragraphing and style. This post deals with structuring paragraphs.

Body Paragraph - The three important elements of successful paragraphs are shown below:
  1. Unity - All sentences should focus on one main idea of the paragraph. Start the paragraph with the topic sentence. The topic sentence should contain the topic and the controlling idea. Ask the question words to come up with the controlling idea. If the paragraph is too long, then it is good to have a concluding sentence.
  2. Coherence - All sentences should be clearly related to each other. Repeat key words. Use synonyms. Use pronouns. Use  transition words 
  3. Development - All sentences should develop the one main idea. Use details and explanation. Use examples and evidence. Use references
TEE Rule - Topic Sentence, Explanation, Examples/Evidence
Introductory Paragraph - State the topic of assignment and comment on its importance. State the main argument. How you intend to answer the question?
Concluding Paragraph - Summarize the main points. State the main conclusion. Has the question been answered?
References
  1. The Elements of Style 
  2. Writing in the Sciences 
  3. Writing Structured Paragraphs