Technical Writing and Communication

Get Started. It's Free
or sign up with your email address
Technical Writing and Communication by Mind Map: Technical Writing and Communication

1. Chapter 2: Rhetoric and Technical Communication

1.1. Rhetorical Problems

1.1.1. Rhetoric: study of the available means of persuasion in any given situation

1.1.2. Exigency and Purpose Inform Define Explain Propose Convince

1.1.3. Workplace Writer Ethos: character or credibility Correctness Experience and Expertise Goodwill Identification: shares common goals, beliefs, ideas, and vision Trust

1.1.4. Audience Use documents differently Skim Read Partially Read Closely Revise and Return Take Related Course of Action Make a Related Decision Expectation and Attitudes Positive Negative Neutral Varies Significantly

1.1.5. Document

1.1.6. Contextual Factors and Constraints

2. Chapter 3: Technical Communication and Electronic Technologies

2.1. Creating Documents

2.1.1. Word Processors Use Templates and Style Guidelines Revise or Change Documents Create Tables or Columns Use Multiple Windows Find and Replace Specific Words or Phrases Insert Symbols, Images, and Words Edit Language and Grammar Style Share or Post Documents on Internet Include Active Hypertext Links

2.1.2. Presentation Software Apply Background and Themes Add Animation, Timing, and Transition Styles Insert Audio, Video, or Graphic Content Switch Between Different Views Share Presentation Upload Presentations

2.1.3. Graphics and Imaging Software Edit and Crop Existing Images Erase or Paint Away Photographs Manipulate or Distort Pixels in Digital Photos Create Text Objects and Graphics Develop Graphic Images of Objects design images to show motion or progress change text appearances add sound or motion

2.1.4. Web-Authoring Software insert text, graphics, and multimedia objects switch between various modes easily upload or post pages use drop-down menu CSS: cascading style sheets internal navigation buttons and external links automatically find and correct bad or unnecessary HTML and XML Coding create design notes

2.1.5. Desktop Publishing Software Booklets Manuels Magazines Cards Newsletters Tickets Calendars

2.1.6. Help and E-Learning Authoring Tools Create and Organize Information Develop Menus Sequence Information Search Functions Glossaries, Appendices, and Table of Contents Navigational Aids

2.1.7. Single-Sourcing Programs

2.2. Communicating and Collaborating

2.2.1. Email Organization Convenience Price Speed

2.2.2. World Wide Web Collaboration Transmission Multimedia Use Storage Access

2.2.3. Internet Private Intranet Electronic Messaging Newsgroups Discussion Lists Web Page Listserves Email

2.2.4. Ethics and Electronic Communication appropriate email address appropriate subject line respect others bandwith "lurk" polish up writing use rules of capitalization use attachments appropriately NOTHING IS PRIVATE back it up and save it

2.2.5. Electronic Messaging AIM Yahoo! Messenger ICQ Texting

2.2.6. Video Conferencing Web-Cameras

2.2.7. Groupware WebEx Lotus SharePoint WebCT Blackboard Combines ALL categories of communication and collaboration

2.3. The Future of Writing and Workplace Technology

2.3.1. Wi-Fi

2.3.2. Improve Bandwidth and Connection Speed

2.3.3. Integration and Portability

2.3.4. Prices Drop

2.3.5. Transnationalism

3. Chapter 7: Organizing and Drafting Documents

3.1. Predrafting Strategies

3.1.1. Confirm Your Purpose

3.1.2. Analyze Your Audience

3.1.3. Gather Your Information

3.1.4. Develop Ideas about the Information Collaboration and Discussion Listing Freewriting Clustering

3.1.5. Organize Your Information Purpose Audience Logic Ethics Organizational Strategy Sequential Chronological General/Specific Order of Importance Division Classification Cause and Effect Comparison/Contrast Spatial

3.1.6. Outline Your Important Ideas Pg. 362 Outlining Topic Outline Sentence Outline (for larger projects use a sentence that summarizes notes)

3.2. Writing the Draft

3.2.1. Parts of a Document Front Matter: title, cover image, date, byline, table of contents, list of figures, executive summary/abstract. materials, parts, or tools lists, inside and resturn addresses, definitions, alerts and warnings, introduction Body: procedures, data (both summary and actual data), steps End Matter: conclusions, additional information, troubleshooting suggestions, additional warnings or alerts, recommendations, indexes, appendixes, glossaries, contact information, follow-up information

3.2.2. A Nonlinear Process

3.2.3. Drafting the Body Coverage and Length Organization and Access

3.2.4. Drafting the Conclusion

3.2.5. Drafting the Introduction Purpose/Objective To Persuade To Instruct To Report To Motivate Scope Pg. 493 Scope: depth and breadth of detail included in a document Statement of the Problem Relevant Information/Background Key Terms Overview of Organization Summary

3.3. Electronic Templates and Wizards

4. Avoid References to Holidays

5. Chapter 1:Technical and Professional Communication in the Workplace

5.1. Genres of Technical Communication

5.1.1. Emails and Memos Handbook pg 329: report results, instruct employees, announce policies, disseminate information and delegate responsibilities. uses headings and lists offer emphasis and clarity; electronic copies should not include simulated initials

5.1.2. Letters

5.1.3. Job Search Documents Job Search and Application Acceptance/Refusal Letters for Employment (9) Application Letters (35) Interviewing for a Job (272) Job Search (286) Resignation Letters (467) Resumes (471) Salary Negotiations (491)

5.1.4. Technical Definitions

5.1.5. Websites

5.1.6. Technical Instructions

5.1.7. Manuels Pg 315: help use and maintain products Tutorials User Manuels Training Manuels Operator's Manuels Service Manuels Special-Purpose Manuels

5.1.8. Proposals and Requests for Proposals Pg 412: used to persuade readers to believe that an idea will benefit them by solving a problem or fulfilling a need Solicited and Unsolicited Proposals Internal and External Proposals Project Management

5.1.9. Informal Reports

5.1.10. Formal Reports

5.1.11. Presentations

5.2. Characteristics of Technical and Professional Communication

5.2.1. Visual Pg. 552: Offers clarity by showing information in a way text alone cannot Drawings Photographs Maps Tables Bar & Column Graphs Line Graphs Picture Graphs Pie Graphs Flowcharts Organizational Charts Symbols

5.2.2. Professional

5.2.3. Research Oriented

5.2.4. Ethical

5.2.5. Technology Oriented

5.2.6. Concise

5.2.7. Audience Centered

5.2.8. Design Centered

5.2.9. Rhetorical

5.3. Activities of Technical and Professional Writing

5.3.1. Planning

5.3.2. Organizing

5.3.3. Researching

5.3.4. Drafting

5.3.5. Designing

5.3.6. Integrating Visuals

5.3.7. Revising

5.3.8. Rewriting

5.3.9. Editing

5.3.10. Testing

5.4. Solving Problems Through Technical and Professional Communication

5.4.1. Plan

5.4.2. Research

5.4.3. Draft

5.4.4. Review

5.4.5. Distribute

6. Chapter 4: Ethics and the Workplace Writer

6.1. What is Workplace Ethics?

6.1.1. Metaethics: where ethical ideas come from

6.1.2. Normative Ethics: right and wrong

6.1.3. Applied Ethics: how events change the way we define right and wrong

6.2. Ethical Guidelines for Workplace Writers

6.2.1. Ethics ≠ Laws Liability Laws Environmental Laws Copyright Laws Patent Laws Trademark and Service Mark Laws Contract Laws

6.2.2. Be Honest benefit public welfare

6.2.3. Respect Confidentiality

6.3. Ethics in Context

6.3.1. Situation and Perceive

6.3.2. Circulation

6.3.3. Revision and Editing

6.4. Ethics and Technology

6.4.1. Code and Other Laws of Cyberspace Laws Social Norms The Market Architecture

6.4.2. E-mail

6.4.3. Websites

6.4.4. Visuals

6.5. Environmental Ethics

6.5.1. Community Environments

6.5.2. Business Environments

6.5.3. Academic Environments

6.5.4. Electronic Environments

6.6. Avoiding Unethical Writing

6.6.1. Don't Use Deceptive or Evasive Language

6.6.2. Don't Obscure or Misrepresent the Issue Abstract Language Jargon Emphasis or Suppression of Information Visual Rhetoric Plagiarism Use of Inaccurate Information

7. Chapter 5: Technical Communication in a Transnational World

7.1. Learning About Differences

7.1.1. Language Target Language Official National Language International English Text Directionality Writing Style

7.1.2. Technology Machine Translation

7.1.3. Education Literacy Common Body of Knowledge Learning Style

7.1.4. Politics and Law Trade Issues Legal Issues Political Traditions and Symbols

7.1.5. Economics

7.1.6. Society Age Business Etiquette Family and Social Interactions

7.1.7. Religion

7.2. Avoiding Stereotypes

7.2.1. Avoid Asssumptions

7.2.2. Ask Questions

7.2.3. Collaborate with the Translator

7.3. Enhances Translation

7.3.1. Terminology

7.3.2. Clarity

7.3.3. Cultural and Rhetorical Differences

7.3.4. Design

7.4. Accommodating Transnational Audiences

7.4.1. Localization General Localization: language, currency, date, and time format Radical Localization: how reader think, feel, and act Benefits of Localization Improve Sales Overcome Inherent Differences First to Enter Niche Markets Overcome Cultural Differences

7.4.2. Internationalization

7.4.3. Globalization

7.4.4. Verbal Communication

7.5. Transnational Ethics

7.6. Guidelines for Writers for Transnational Audiences

7.6.1. Write Clearly Use Correct Punctuaion Pg. 114 Dashes: used to link, separate, and enclose. Can be used for emphasis, informality, or abruptness. Include Definite Articles Avoid Using Pronouns Pg. 405 Pronouns: refers clearly to a specific antecedent Use Terminology Consistently Pg. 248 Idioms: a group of words, or phrase, that has a special meaning apart from its literal meaning. Example: "hand in" means "submit" Avoid Idiomatic Language Avoid Comparatives

7.6.2. Localize Your Writing Recognize Alphabetic Differences Use Local Numbers Be Alert to Time Differences Avoid Cultural References Avoid Humor

7.6.3. Account for Visual and Auditory Perceptions Consider Visual Interpretations Avoid Images of People and Hand Gestures Reevaluate Design Elements and Priciples Account for Differences in Sound Interpretation