Technical writings for academics

Technical writings for academics

• 1.
  Technical Writings forAcademics of Higher Education Institutes in India Dr. Tapan Barui, Assistant Professor Department of Library & Information Science University of North Bengal Email: tapanbarui13@gmail.com
• 2.
  Introduction Disseminating technical informationgathered in course of doing research work is as important as collecting the information itself. One can disseminate the information by writing documents on one’s work. Students, researchers, faculties, engineers and scientist work very hard to achieve meaningful results and usually make no compromise on maintaining high work standards. However, when it comes to documenting the results after finishing the work, most of them feel hesitation or somewhat lethargic in doing so. Thus, even a successful researcher; despite of knowing the importance of preparing such document, hesitate to present in seminars, conferences or workshops some times to publish a paper in journals.
• 3.
  What is TechnicalWriting? Technical writing introduces to some of the most important aspects of writing in the world of science, technology, and business – the kind of writing that scientists, doctors, computer specialists, government officials, engineers, academics and other people who are attached with higher education system do as a part of their regular work. In the fields of science and technology, technical writing may be defined as “any writing that is geared towards technical and scientific audiences”.
• 4.
  What is TechnicalWriting? The term “technical” refers to knowledge that is not widespread, that is more the territory of experts and specialists. Whatever your major is, you are developing an expertise, and whenever you try to write anything about your field, you are engaged in technical writing.
• 5.
  What is TechnicalWriting? Technical writing andTechnical communication are often used synonymously.  Technical communication can be written, oral, or visual.  Technical writing is composed in and for the workplace.  Technical writing is a significant factor in work experience for a variety of reasons.  Technical writing serves valuable purposes in the workplace and often involves teamwork.
• 6.
  Technical writing, generalacademic writing, and creative writing or fiction Technical Writing Academic Writing Creative Writing Purpose To inform To persuade, argue To entertain To instruct Content Factual , straight forward Factual , straight forward Imaginative, metaphoric Format Proposal Introduction Background Purpose Methodology Results Conclusions No set format Thesis Reasons Evidence No set format Progress Report Technical Report Style Writing is simple—declarative sentences Writing may draw attention to itself Writing is the important part Concise sentences and paragraphs Longer sentences and paragraphs May include long sentences for effect Avoid personal Personal pronouns Personal may be assumed, even in academic arguments Narrators, etcPersonal judgments Personal feelings Formal Formal Formal, figurative Clear topic sentences Clear topic sentences, may vary for argumentative effect No clear topic sentences Specialized vocabulary Some specialized vocabulary, depending on audience No specialized vocabulary
• 7.
  Contents of TechnicalWriting A technical paper expounds some new idea. Alternatively/ additionally, it may present: 1. A new interpretation of known idea. 2. New data based on observation and analysis together with an interpretation of the data to bring out their significance and value. 3. A view of the subject from a new perspective oriented to another subject or establishing correlation among ideas in different subjects. 4. A historical or developmental, or evolutionary treatment of the subject. 5. An evaluation of an existing theory, proposition or practice. 6. A substitute for an existing theory proposition or practice. 7. An application of known idea or methodology from another subject for the development of the subject in question. 8. Known idea in a new setting.
• 8.
  Purpose of technicalwriting Technical writing is the delivery of technical information to readers in a manner that is adapted to their needs, level of understanding, and background. Technical writing is intended to communicate to a specific audience, for a specific purpose.
• 9.
  Characteristics of EffectiveTechnical Writing  Clarity  Conciseness/brevity  Accuracy  Organization/ Integrity  Ethics/Honesty  Objectivity
• 10.
  The Writing Process
• 11.
  Writing Is aProcess  Good writing doesn’t happen overnight; it requires planning, drafting, rereading, revising, and editing.  Learning and improvement requires self-review, peer-review, subject-matter expert feedback, and practice.  There are no shortcuts; practice makes perfect!
• 12.
  Summary and conclusions Nomatter how poor you think your writing skills are, you really can learn how to improve them. Good technical writing is about using plain English. This is much easier than the writing style taught to many of you at school. You do not have to know and use long words and complicated phrases. You do not have to make your writing more ‘interesting’ by thinking of different ways to describe the same thing. In fact, the simpler and shorter you make things, the more likely you are to produce technical reports that get results. The crucial points are:  Plan your project before you begin drafting.  Understand basic qualities of good technical writing; use the examples presented to guide you in your writing and revising process.  Good writing is a habit that takes time to develop; practice makes perfect.
• 13.
  Sources  Society forTechnicalCommunication  Technical Writing - A Dalton: Organizing  Online Technical Writing: Information Infrastructures – Comparison  OnlineTechnicalWriting