Course Outline

Introduction

  • Creating Documentation that Gets Used

Requirements Gathering

  • How to Look at an Instruction Manual from the Eyes of the User
  • Gathering and Understanding Requirements (Internal and External)
  • What to Include in Technical Documentation and What to Leave Out

Planning

  • Planning a Technical Writing Project
  • Schedules and the Product Lifecycle

Writing

  • Writing a Minimal Viable Draft
  • Making Your Writing Understandable
  • The Importance of Iteration in the Writing Process

Structuring

  • Structuring a Document
  • Making Content Searchable

Appearance

  • Adding Illustrations and Diagrams
  • Formatting and Layout Techniques
  • Using Typography to Enhance Readability

Tools

  • Using Technical Documentation Tools and Templates

Revision

  • Optimizing the Technical Documentation Workflow
  • Formalizing the Review and Revision Process

Translation

  • Translation and the Translation Process

Publishing

  • Publishing a Technical Document

Post-Publishing

  • Obtaining Feedback from Users
  • Updating and Maintaining Technical Documentation

Summary and Conclusion

Requirements

  • No special requirements other than having a product a service that requires technical documentation.

Audience

  • Non-writers (e.g., developers, engineers, technical managers, designers, product and project managers, etc.)
 14 Hours

Number of participants



Price per participant

Testimonials (5)

Related Courses

Software Engineering

35 Hours

The Principal Engineer - Masterclass

14 Hours

SNAP IFPUG Software Size Estimation and Measurement

14 Hours

Impacted Function Point (IFP)

7 Hours

Unit of Software Measurement Parameterization (UMSP)

7 Hours

FlexNet Publisher Fundamentals

14 Hours

AI-Augmented Software Engineering (AIASE)

14 Hours

AI Coding Assistants: Enhancing Developer Productivity

7 Hours

OCUP2 UML Certification - Preparing for the UML2 Intermediate exam.

14 Hours

OCUP2 UML Certification - UML2 Advanced Exam Preparation

14 Hours

Embedded C Application Design Principles for Automotive Professionals

14 Hours

Technical Architecture and Patterns

21 Hours

Embedded C Application Design Principles

14 Hours

Model Based Development for Embedded Systems

21 Hours

Architecture and Design: Core + Advanced Training

42 Hours

Related Categories