Qualities of good technical writing along with comparison between technical and non-technical writing

13,001 views

Published on

Published in: Education, Business

Qualities of good technical writing along with comparison between technical and non-technical writing

  1. 2. Qualities Of Good Technical Writing
  2. 3. What is Good Technical Writing? <ul><li>Technical writing is the process of conveying technical information through writing to a specific audience. </li></ul><ul><li>If the intended audience can perform an action or make a decision based on that information then that writing can be considered as Good Technical Writing . </li></ul>
  3. 4. Qualities of Good Technical Writing <ul><li>Planning </li></ul><ul><li>Clarity </li></ul><ul><li>Brevity </li></ul><ul><li>Simplicity </li></ul><ul><li>Word Choice </li></ul><ul><li>Active Voice </li></ul><ul><li>Committing to writing as a process </li></ul>
  4. 5. Planning: Before You Begin <ul><li>Identify your audience and their expectations </li></ul><ul><li>Know your purpose </li></ul><ul><li>Know your material </li></ul><ul><li>Understand the writing task at hand </li></ul><ul><li>Organize your thoughts and materials </li></ul><ul><li>Budget adequate time to write, review, revise and edit. </li></ul>
  5. 6. Clarity: Avoid Jargon <ul><li>Jargon: a vocabulary particular to a place of work (abbreviations, slang) </li></ul><ul><li>Audience familiarity with the topic determines appropriate use of jargon </li></ul>
  6. 7. Clarity: Define the Unfamiliar <ul><li>If you must abbreviate, define the term in its first occurrence, and put abbreviations in parentheses. </li></ul><ul><li>Italicize first occurrence of unfamiliar terms and define them right away. </li></ul>
  7. 8. Brevity: <ul><li>Use Words Efficiently. </li></ul><ul><li>Less Is More. </li></ul><ul><li>Most Important First. </li></ul><ul><li>Remove Redundancy. </li></ul>
  8. 9. Simplicity: Use Details Wisely <ul><li>Specific details are desirable, but be careful to balance detail with audience needs for clarity —significance is more important. </li></ul><ul><li>Many engineers want to provide as much specific detail as possible, but this can come at the expense of readers understanding and their main point. </li></ul>
  9. 10. Word Choice:
  10. 11. Word Choice: <ul><li>Avoid too many “to be” verbs </li></ul><ul><ul><li>“ is” “was” “were” “has been” “have been”. </li></ul></ul><ul><li>Avoid excess words , which slow comprehension of the main point. </li></ul>
  11. 12. Active Voice: <ul><li>Technical writers want to communicate as efficiently as possible, and active voice is more straight forward and is stronger than passive voice. </li></ul><ul><li>When in doubt, read passages out loud to determine the natural sound. </li></ul>
  12. 13. Writing Is a Process <ul><li>Good writing doesn’t happen overnight; it requires planning, drafting, rereading, revising, and editing. </li></ul><ul><li>Learning and improvement requires self-review, peer-review, subject-matter expert feedback, and practice . </li></ul>
  13. 14. Examples
  14. 15. Non-Technical
  15. 16. Poem: Suicide <ul><li>An underlying sense of counting down: Rhythmic, deep enteric thuds - Each another year to fret and frown About, wading in the claggy mud That constitutes a blackened life. </li></ul>
  16. 17. Poem: Suicide <ul><li>A glint of blade had caught a baggy eye To spark a thought to jump the fence. Could I grasp the handle – was I shy Of what I had to do and hence remain Enshrined in overwhelming strife? </li></ul>
  17. 18. Poem: Suicide <ul><li>The metal glimmered once again To beg the possibility Of halting once and all the pain To relish an eternity </li></ul><ul><li>Of rested shoulders, Peace of mind, So here, my wrist; Now quick and kind. </li></ul>
  18. 19. Technical Writing & Good Technical Writing
  19. 20. Comparison <ul><li>Good Technical </li></ul><ul><li>A student of JINNAH UNIVERSITY allegedly committed suicide on Monday in his hostel room over poor results. The police said the young man hanged himself. </li></ul><ul><li>Technical </li></ul><ul><li>A student of Jinnah University allegedly committed suicide on Monday in his hostel room over poor results. The police said the young man hanged himself. </li></ul>
  20. 21. Comparison <ul><li>Good Technical </li></ul><ul><li>Ali of Faisalabad was doing graduation with CALCULUS as major subject at the Jinnah University. He, in the last year of his education, could not achieve passing numbers in the last term examinations and failed to maintain the grade. According to the university officials, the university administration separated him from his courses due to which he was disheartened for the last five days. </li></ul><ul><li>Technical </li></ul><ul><li>Ali of Faisalabad was doing graduation with calculus as major subject at the Jinnah University. He, in the last year of his education, could not achieve passing numbers in the last three term examinations and failed to maintain the grade. According to the university officials, the university administration separated him from his courses due to which he was disheartened for the last five days. </li></ul>
  21. 22. Comparison <ul><li>Good Technical </li></ul><ul><li>O n Monday, Ali’s mother called him on his cell phone but he did not attend the call after which she rang up her younger son Ahmed, a third year student at the same university. Ahmed reached his brother’s room and on finding no response broke opened the door and found Ali hanging with the ceiling fan. “ FORMAL LANUAGE ” </li></ul><ul><li>Technical </li></ul><ul><li>On Monday, Ali’s mother called him on his cell phone but he did not attend the call after which she rang up her younger son Ahmed, a third year student at the same university. Ahmed reached his brother’s room and on finding no response broke opened the door and found Ali hanged with the ceiling fan. </li></ul>
  22. 23. Comparison <ul><li>Good Technical </li></ul><ul><li>The police, after being informed, reached the scene and started investigating the matter. According to another student, Ali seemed normal during the breakfast; however he was not present in the campus that day. “ NO CHOPPY SENTENCES ” </li></ul><ul><li>Technical </li></ul><ul><li>The police, after being informed, reached the scene and started investigating the matter. According to another student Ali seemed normal during the breakfast; however he was not present in the campus that day. </li></ul>
  23. 24. Comparison <ul><li>Good Technical </li></ul><ul><li>Initial investigation revealed that Ali was disturbed over his continuous failure in the exams and finally got dejected after his parents received a letter from the university administration about his poor performance. </li></ul><ul><li>A report from a newspaper says “ About 200 disciples (students) commit suicide every year because of increasing tensions regarding studies.” “ FACTS ” </li></ul><ul><li>Technical </li></ul><ul><li>Initial investigation revealed that Ali was disturbed over his continuous failure in the exams and finally got dejected after his parents received a letter from the university administration about his poor performance. </li></ul>
  24. 25. Conclusion <ul><li>Plan your project before you begin drafting. </li></ul><ul><li>Understand basic qualities of good technical writing ; use the examples presented to guide you in your writing and revising process. </li></ul><ul><li>Good writing is a habit that takes time to develop ; practice makes perfect. </li></ul>
  25. 26. Thank you very much….!! Writing is an occupation in which you have to keep proving your talent to those who have none.

×