Estimating Time Budgets for Documentation Projects

Advanced Technical Communication training course

Review of technical writing fundamentals

Single Sourcing and Content Reuse

Read Me First
Introduction (1:19)
Definitions (10:29)
Why Single Source? (11:28)
When Single Sourcing Might be a Bad Idea (1:48)
General Approach (7:04)
Writing for Reuse (15:44)
Structured Writing (1:53)
Planning (8:43)
Publishing (4:50)
Tools (16:20)
Summary (2:06)

Revising and Editing Content

Editing - Part 1 (12:37)
Editing - Part 2 (14:14)
Revising Content (12:35)
Revising Tools (9:45)
Exercises
Getting Your Content Reviewed (10:18)
The Relationship Between Editors and Writers (9:46)

Introduction to DITA 1.2

Read Me First
Module 1 Introduction (10:52)
Module 2 DITA Fundamentals (13:24)
Module 3 Introduction to Topics (9:55)
Module 4 Different Types of Topics (17:08)
Module 5 Maps (7:04)
Module 6 Linking (15:46)
Module 7 Conrefs (8:36)
Module 8 Conditional Content (5:23)
Module 9 Transforming and Publishing DITA (10:11)
Module 10 Summary (1:23)
Future Developments (3:54)

Structured Writing Fundamentals

Welcome (2:35)
Definitions (5:24)
What is structured writing? (2:23)
Why do we need structured writing? (2:52)
Non-automated structured writing (23:47)
XML structured writing - introduction (13:51)
XML structured writing - standards (8:24)
DITA 1.2 - Read Me First
DITA 1.2 - Module 1 Introduction (10:52)
DITA 1.2 - Module 2 DITA Fundamentals (13:24)
DITA 1.2 - Module 3 Introduction to Topics (9:55)
DITA 1.2 - Module 4 Different Types of Topics (17:08)
DITA 1.2 - Module 5 Maps (7:04)
DITA 1.2 - Module 6 Linking (15:46)
DITA 1.2 - Module 7 Conrefs (8:36)
DITA 1. 2 - Module 8 Conditional Content (5:23)
DITA 1. 2 - Module 9 Transforming and Publishing DITA (10:11)
DITA 1. 2 - Module 10 Summary (1:23)
XML structured writing - problems (3:28)
Structured writing - Databases (27:13)
Summary (4:25)

Managing Software Documentation Projects

What is Technical Documentation? (19:50)
Making the Business Case for Technical Documentation (14:39)
Estimating Time Budgets for Documentation Projects (24:06)
Technical Documentation Standards (7:30)
Metrics in Technical Documentation (27:44)
Developing User Documentation in an Agile Environment (13:02)

Documenting REST APIs

Introduction to REST APIs (49:14)
Using an API (14:11)
Documenting APIs (32:17)
Design Patterns in API Documentation (30:19)
Managing an API Project (16:28)
Copy of the slides

Markdown

New Trends in Technical Writing

Why are changes happening? (10:29)
The Trends (42:49)
Design Led Documentation (23:52)
Troubleshooting topics (3:50)
Sequencing (7:21)
User Generated Content (11:37)
What is Microsoft doing? (14:11)

UI/UX Writing (work in progress)

Welcome (4:53)
Messaging components (8:52)
Messaging states (11:04)
Definitions - What is UX and UI? (6:51)
How do I create UI text for an application? (11:47)
Creating inline Help (3:37)
What is the purpose of UI text? (1:51)
Standards (4:55)
Writing best practices (11:58)
What skills do I need to be a UI/UX writer? (4:15)
Planning (11:20)
Usability (6:56)
Writing for a global audience (3:18)

Audio-only content

Lecture content locked

If you're already enrolled, you'll need to login.