Primary Considerations
Introduction to Technical Communication.
Technical Writing Serves Practical Needs. Writing Is Part Of Most Careers. The Information Age Requires Excellent Writing Skills. Technical Writers Face Interrelated Challenges. Many Technical Writers Collaborate.
Preparing to Write: audience/purpose analysis.
Use A Communications Model. Assess Readers' Information Needs. Identify levels of Technicality. Develop an Audience/Purpose Profile. Exercises. Collaborative Project.
Writing Efficiently.
Getting Started. How to Save Writing Time. Composing With a Word Processor. The Process in Action. Exercises. Collaborative Project.
Persuasive Writing.
Assess the Political Realities. Expect Reader Resistance. Know How to Connect With Readers. Ask for a Specific Decision. Never Ask for Too Much. Recognize All Constraints. Exercises. Collaborative Project.
Writing Ethically.
Recognize Unethical Communication. Expect Social Pressure to Produce Unethical Communication. Never Confuse Teamwork with Groupthink. Rely on Critical Thinking for Ethical Decisions. Anticipate Some Hard Choices. Never Depend Only on Legal Guidelines. Understand the Potential for Communication Abuse. Know Your Communication Guidelines. Exercises. Collaborative Project. Decide Where and When to Draw the Line. An Ethics Checklist for Communicators. Exercises. Collaborative Project.
Information Gathering, Analysis, and Manipulation.
Gathering Information.
Thinking Critically About The Research Process. Exploring Secondary Sources. Exploring Primary Sources. Exercises. Collaborative Project.
Recording and Reviewing Research Findings.
Recording the Findings. Evaluating and Interpreting Information. Reassessing the Entire Research Process. Exercises. Collaborative Project.
Documenting Research Findings.
Why You Should Document. What You Should Document. How You Should Document. MLA Documentation Style. APA Documentation Style. CBE Numerical Documentation Style. Exercises. Collaborative Project.
Summarizing Information.
Purpose of Summaries. Elements of Summary. Critical Thinking in the Summary Process. A Sample Situation. Forms of Summarized Information. Exercises. Collaborative Project.
Structural, Style, and Format Elements (Chapters 10-13).
Organizing for Readers.
Topical Arrangement. Outlining. Paragraphing. Sequencing. Exercises. Collaborative Project.
Editing for Readable Style.
Editing for Clarity. Editing for Conciseness. Editing for Fluency. Finding the Exact Words. Adjusting Your Tone. Considering the Cultural Context. Avoiding Reliance on Automated Tools. Using Objective Self-Evaluation Tools. Exercises. Collaborative Project.
Designing Visuals.
Why Visuals Are Essential. When to Use a Visual. What Types of Visuals to Consider. How to select Visuals for Your Purpose and Audience. Tables. Graphs. Charts. Graphic Illustrations. Computer Graphics. How to Avoid Visual Distortion. How to Incorporate Visuals with Printed Text. Exercises. Collaborative Project.
Designing Pages and Documents.
Page design in Workplace Writing. Desktop Publishing. Page-Design Guidelines. Audience Considerations in Page Design. Designing On-Screen Pages. Exercises. Collaborative Project.
Descriptive Writing.
Definitions.
Purpose of Definitions. Elements of Definitions. Types of Definitions. Expansion Methods. Sample Situations. Placement of definitions. Exercises. Collaborative Project.
Descriptions and Specifications.
Purpose of Description. Objectivity in Description. Elements of Description. A General Model for Description. A Sample Situations. Specifications. Exercises. Collaborative Project.
Process Analyses, Instructions, and Procedures.
Process Analysis. Elements of Instruction. Measurements of Usability. A Sample Set of Instructions. Procedures. Exercises. Collaborative Project.
Manuals.
Types of Manuals. Manual Writing. Parts of Manuals. Format Considerations. Section Identification. Headings system. Page Layout. Exercises. Collaborative Project.
Applications.
Proposals.
Purpose of Proposals. The Proposal Process. Proposal Guidelines. A General Structure for Proposals. Sample Proposals. An Interpersonal Perspective. Graphics in Proposals. Exercises. Collaborative Project.
Formal Analytical Reports.
Four Main Types of Analysis. Typical Analytical Problems. Elements of Analysis. A General Model for Analytical Reports. Parts of a Formal Report. A Sample Situation. The Process of Writing Reports. A Sample Formal Report. Exercises. Collaborative Project.
Document Supplements.
Purpose of Supplements. Cover. Transmittal Document. Title Page. Summary. Table of Contents. List of Tables and Figures. Documentation. Glossary. Appendixes. Exercises. Collaborative Project.
Short Reports.
Formats. A Structure For All Purposes. Action Closing. Progress Reports. Two Sample Progress Reports. Project Completion Report. Inspection Report. Field Trip Report. Meeting Minutes. Feasibility Reports. Causal Analysis. Assessment Reports. Recommendations Reports. Lab Reports. Form Reports. Writing A Short Report Efficiently. Exercises. Collaborative Project.
Workplace Correspondence.
Letter Format. Basic Elements Of Letters. Specialized Parts Of Letters. Design Factors. Memo Usage and Format. Format. Facsimile Transmission. Electronic Mail. Interpersonal Elements of Workplace Correspondence. Structures For Workplace Correspondence. Length of Workplace Correspondence. A Final Word. Exercises. Collaborative Project.
Job Search Communications.
Self-Assessment Inventory. Personal Job Assessment. Your Career Orientation. Choosing Positions to Pursue. Job Market Research. Producing Job Search Materials. Contacting Employers. Employment Interviews. Exercises. Collaborative Project.
Oral Presentations.
Speaking Situations for Technical People. Factors in Success. Four Presentation Styles. Delivering Extemporaneous Talks. Impromptu Speaking. Preparing Your Presentation. Delivering Your Presentation. Exercises. Collaborative Project.
