Monday, March 31, 2014

Content Writing [Technical] - Some Prerequisites

Writing is an art. It requires rational thinking, analytical approach, logical flow of ideas, conciseness and preciseness of information, completeness of information, methodical and lucid presentation of arguments, etc. However, the approach may vary depending on the type of writing and the perspective of the writer.

Writing can be broadly classified into two categories: creative writing and non-creative (technical) writing. Creative writing aims at revealing facts, meditates on abstract thoughts, involves imagination, feelings, etc. On the other hand, non-creative or technical writing deals with information sharing, widens the knowledge base, educates the audience on proven facts, etc.

The purpose of a written piece of information is to convey the message to its audience such that most of it is understood and grasped. However, a writer sometimes comes across a complex situation where the probability of deviation from the facts increases to a large extent or where the information cannot be expressed in concise manner and thus forces the writer to infuse more words into the write-up, inviting the chances of ambiguity.

Here we will confine ourselves to non-creative (technical) writing. Following are some of the points that an aspiring technical writer must keep in mind:

Read Before You Write

Reading habit generally makes you aware of the presentation of idea and widens your perspective. It helps you increase your vocabulary, determine the most probable questions that may crop up in the readers’ mind as well as the answers of those questions, equips you with all necessary tools required for writing.

Audience Level 

Keep the target readers in mind while writing else it will turn out to be irrelevant and will not meet the objective.

Clarity of Thought 

A writer must be clear about the facts he is writing on. Presenting facts properly with correct usage of words, grammatical accuracy of content, and accuracy of information is indispensable part of writing. Do not deviate from the main objective as it may mislead the reader.

Completeness of Information

Incomplete information is never conclusive and therefore would beat the purpose of writing. In technical writing, information must be given pedagogically.

Relevancy of Information 

The facts described to support the topic or idea must be relevant.

Flow of Information 

The flow of information must be seamless. Starting from the introduction to the supporting fact through the conclusive part, the description of idea or concept must flow smoothly. The terms that are not in vogue, slangs, cliché and jargons should be avoided.

Preciseness of Information 

This is one of the most sought-after criteria in technical writing. The facts/information provided must be correct and should not lead to ambiguity or falsity.

Avoid Overwriting 

Avoid usage of unnecessary words and phrases in your writing. Over-usage of words to explain the facts distracts a reader from the main point of discussion. It thus hampers the process of insemination of information from writer to reader.

Structure and Design 

Once you have made all the groundwork, it’s time to finally prepare the draft, decide the proper structure and layout, and make it ready for the readers. Properly structured content easily receives attention of the readers and helps them retain maximum of the idea for longer time.

Editing and Proofreading - The Basic Differences

Many people consider editing and proofreading as the same thing and pay less heed to these stages of publishing. This sometimes paves way for some basic and silly errors to creep in the document and thus the document fails to deliver information in proper manner. Editing and proofreading stages are important stages as most of the typographic, presentation and consistency -related, and sometimes conceptual and factual errors, are filtered out in these stages.

Here’s a brief description about the editing and proofreading processes and some basic differences between them.

Editing  

Once the first draft of a piece of text is complete, it is submitted to editing for review. Editing deals with the structure, organization, and presentation of content. It involves rephrasing for smoothness and simplification of the content. 

Editing ensures:
  • Clarity of expression
  • Elimination of ambiguity from the text
  • Consistency
  • Proper flow of idea/concept
  • Completeness of content
  • Relevancy of the information
  • Logical and meaningful flow of content
  • Grammatical accuracy

Proofreading
Proofreading stage comes next to the editing stage. In this stage, grammatical accuracy, layout, and presentation of the content are taken care of and substantive rephrasing is not allowed.

Proofreading ensures that:
  • There is no typing error in the text.
  • The spellings in the text are correct.
  • The content follows the same style throughout.
  • The format and layout of the content is correct.
  • Punctuation marks are used correctly.