Table of Contents

Praise for the Book

Copyright Page

About This Book

Part 1: About the Profession

• Chapter 1: Introduction to Technical Writing. Introductory overview of the technical writing field, its evolution, and pathways into the profession, tailored for newcomers and career changers.
• Chapter 2: Technical Writing Roles and Responsibilities. In-depth exploration of the diverse roles and day-to-day responsibilities of technical writers across different specialties.
• Chapter 3: Essential Skills for Technical Writers. Detailed guide to the key hard and soft skills necessary for a successful career in technical writing, including technology proficiency and interpersonal abilities.
• Chapter 4: Breaking into Technical Writing. Advice on entering the technical writing field, covering education paths, career transition strategies, and real-life success stories.
• Chapter 5: Career Growth and Survival for Technical Writers. Career development strategies for technical writers at various stages, from overcoming challenges to exploring managerial roles and other opportunities.
• Chapter 6: Career Flexibility in Technical Writing. Examination of the flexible working options in technical writing, including remote, freelance, and cross-time-zone work, along with their benefits and challenges.

Part 2: Process

• Chapter 7: Tailor the Process. Guidelines on adapting the technical writing process to fit specific projects and organizational needs, with case studies for practical illustration.

Part 3: Methods

• Chapter 8: Artificial Intelligence (AI) for Technical Writers. Evaluation of AI’s impact on technical writing, covering its benefits, limitations, and integration into the writing process.

Part 4: Plan

• Chapter 9: Collect Information. Techniques and strategies for effective information collection, using frameworks like the DIKW Pyramid, and preparing for documentation projects.
• Chapter 10: Make a Plan. Step-by-step guidance on planning documentation projects, emphasizing the importance of the PADRE method and Agile planning.
• Chapter 11: Analyze Audience. Comprehensive approach to understanding and categorizing audiences in technical writing, using audience analysis methods and persona development.
• Chapter 12: Define Review Team. Guidance on defining a review team early in the planning phase to ensure the accuracy and quality of technical documents.

Part 5: Design

• Chapter 13: Design Structure. Insight into structuring technical documents for effectiveness and user-friendliness, including different organizational taxonomies and real-world application examples.
• Chapter 14: Design Stylesheet. Deep dive into the use of stylesheets in document design, exploring graphic design principles and the impact of visual reading patterns on technical documentation.
• Chapter 15: Design Templates. Practical guidance on creating and using templates in technical writing, emphasizing consistency, branding alignment, and the role of AI in template creation.

Part 6: Write

• Chapter 16: Writing Principles. Fundamental principles of technical writing, with a focus on empathizing with readers, organizing information, and crafting polished prose.
• Chapter 17: Write Draft. Guidance through the drafting stage in technical writing, including the iterative nature of writing, engagement with experts, and version control.
• Chapter 18: Include Images. Importance of using visuals in technical documentation, covering theories like multimedia learning and cognitive load, and practical image selection tips.

Part 7: Edit

• Chapter 19: Edit Drafts. Comprehensive overview of the editing stage in technical writing, including levels of editing, the use of AI tools, and practical editing steps.

Part 8: Review

• Chapter 20: Review Draft. Detailed guide to the review phase in technical writing, covering peer and expert reviews, review etiquette, and managing feedback effectively.
• Chapter 21: Validate and Test Information. Emphasis on the importance of validation and testing in ensuring the accuracy and effectiveness of technical documentation.

Part 9: Translate

• Chapter 22: Translation Theory. Exploration of translation and localization theories in technical writing, emphasizing cultural and linguistic nuances.
• Chapter 23: Translation Practice. Practical strategies for managing translation projects in technical documentation, from document preparation to working with translation service providers.

Part 10: Publish

• Chapter 24: Publish. Principles and practical steps for document control, publication, and communication with stakeholders in the final stages of document creation.

Part 11: Manage

• Chapter 25: Manage Progress. Comprehensive guide to using tools and methodologies for tracking and managing progress in technical documentation tasks.

Templates

Samples

Glossary