tech m1-2

• Technical Writing


  Writing for a specific purpose and with a specific goal, usually to inform/instruct, persuade/argue
• Technical writing is considered transactional writing because


  There are two people or groups involved in the communication, with one party having a clear goal to inform or persuade the other party
• Technical Writing


  An audience-centered means of communication that provides a reader with clear and easy access to information
• In the business world, time equates to profit, and profit is the force behind all business interaction because

  The technical writer and reader have a vis-à-vis relationship, where the writer recognizes, respects, and addresses the importance of time in effective and efficient communication
• Technical writing is important as it will be used by most college graduates as a regular part of their work
• Examples of when technical writing skills are needed

  • Getting a job – preparing a resume or curriculum vitae, cover letter, application, and portfolio
  • Doing your job – preparing memos, letters, reports, instructions, case reports, reviews, assignments, descriptions, etc.
  • Keeping your job – communicating with management, co-workers, peers, patients/students/public
• Purpose of Technical Writing

  To provide complex information to readers in a way that they can understand and apply, even if they don't have prior knowledge of the topic
• Purposes of Technical Writing

  • To inform
  • To instruct
  • To refer
  • To persuade
• Properties of Technical Writing

  • Accuracy
  • Clarity
  • Descriptiveness
  • Correctness
• Accuracy


  Maintaining accuracy in technical writing is essential to convey quality content
• Clarity


  Write in a layman’s tone to ensure understanding, avoid jargon, keep language simple and meaningful
• Descriptiveness


  Be detailed in describing technical products to cater to customers from non-technical backgrounds
• Correctness


  Use correct grammar and sentence structure in technical writing
• Technical writing requires that you cover every aspect of the product's functioning
• Technical communication has a specific audience and is purposeful, usually intended to solve a problem for that audience
• Technical communication is focused on readability issues, including clear writing, page design, and graphics
• Principles to guide technical writing

  • Remember your purpose
  • Remember your audience
  • Make content specific to purpose and audience
  • Write clearly and precisely
  • Make good use of visuals
  • Be ethical
• Technical communication serves both explicit and implicit purposes
• The problem statement defines the problem and explains what about the topic is at issue
• Elements of technical writing

  • Product
  • Developers
  • Audience
  • Tasks
  • Deliverables
  • Environment
  • Schedule
• Uses of Technical Writing

  • Create brochures
  • Newsletters
  • Instruction manuals
  • Product descriptions
  • Marketing and promotional materials
• Types of Technical Writing

  • Legal
  • Medical
  • Scientific
  • Mechanical
  • Business
  • Expository
• Technical writing always has a definite purpose and will always have a reader
• Technical writing is always nonfiction, with the purpose of educating or instructing
• Creative writing can be fiction, nonfiction, or a combination of both, and can serve any purpose
• Technical writing is different from essay and creative writing