Technical Communication Notes

What is Technical Communication?

  • Technical communication involves finding, creating, and delivering technical information in the workplace through documents like proposals, emails, reports, podcasts, computer help files, blogs, and wikis.

  • It encompasses activities to discover, shape, and transmit information, using listening, speaking, reading, and writing to analyze problems, evaluate evidence, and draw conclusions.

  • Focuses on purpose and audience, aiming to help others learn, carry out tasks, or make decisions, and to reinforce or change attitudes and motivate action.

Understanding Purpose

  • Technical communication aims to solve problems by helping others learn, carry out tasks, or make decisions.

  • It can also reinforce or change attitudes and motivate readers to take action, such as influencing public policy.

Understanding Audience

  • Technical communication requires addressing a clearly defined audience with specific needs and purposes.

  • Audiences may include peers, supervisors, and individuals outside the company, each with different perspectives and levels of knowledge.

Why Technical Communication Skills Are Important

  • Employers seek individuals with strong communication skills, valuing them even more than specific field knowledge.

  • Essential skills include verbal communication, teamwork, problem-solving, planning, and data analysis.

Challenges of Producing Technical Communication

  • Producing technical communication involves considering audience-related, purpose-related, setting-related, document-related, and process-related factors.

Audience-Related Factors

  • Consider the audience's problem-solving needs, subject knowledge, attitudes, language proficiency, cultural assumptions, and accessibility requirements for people with disabilities.

Purpose-Related Factors

  • Determine the primary goal: informing, persuading, or branding. Community specialists now coordinate online presence and social media, managing documents from tweets to blog posts.

Setting-Related Factors

  • Analyze the situation surrounding the problem, including the stakes, context, and environment in which the document will be used.

  • Consider social, political, and ethical norms of the setting.

Document-Related Factors

  • Determine the type of content and its role in problem-solving. The subject should guide document and media choices, adapting templates as necessary.

Process-Related Factors

  • Establish the document production process, considering time, budget, and resource constraints. Determine if updates or maintenance will be required.

Characteristics of a Technical Document

  • Addresses a particular audience, helping them solve problems, reflecting the organization's goals and culture, and is produced collaboratively. It uses design to increase readability, consisting of words, images, or both.

Guidelines: Measures of Excellence in Technical Documents

  • Honesty: Tell the truth to avoid misleading readers.

  • Clarity: Ensure the document is easily understood.

  • Accuracy: Provide correct and unbiased information.

  • Comprehensiveness: Include all necessary information and detail.

  • Accessibility: Design for users with varying physical abilities.

  • Usability: Measures how successfully a document achieves its purposes and meets its audience's needs.

  • Conciseness: Convey information economically.

  • Professional Appearance: Ensure a neat, well-designed document.

  • Correctness: Adhere to conventions of grammar, punctuation, spelling, mechanics, and usage.

Skills and Qualities Shared by Successful Workplace Communicators

  • Research skills (primary and secondary).

  • Ability to analyze information.

  • Clear speaking and writing skills.

  • Honesty, willingness to learn, emotional intelligence, generosity, monitoring of best information, self-discipline, ability to prioritize and respond quickly.

Communicating Professionally

  • Be honest and admit mistakes.

  • Be willing to learn continuously.

  • Display emotional intelligence.

  • Be generous in sharing information.

  • Monitor the best sources of information.

  • Be self-disciplined and organized.

  • Prioritize tasks and respond quickly.