Welcome
Review of technical writing fundamentals
Single Sourcing and Content Reuse
Revising and Editing Content
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? (8:57)
-
Making the Business Case for Technical Documentation (14:31)
-
The Writing Process (10:34)
-
Estimating Time Budgets for Documentation Projects (31:54)
-
Planning your content (12:17)
-
Technical Documentation Standards (13:20)
-
Metrics in Technical Documentation (30:29)
Markdown and Asciidoc
Trends in Technical Writing
-
Introduction and exercises (20:33)
-
The traditional approach (4:05)
-
Why change? (11:44)
-
Trends - Onboarding and voice (19:33)
-
Trends - Pathfinder topics (4:08)
-
Trends - DocOps (2:35)
-
Trends - Analytics (7:54)
-
How you could make your Help topics appear at the top of the Search Engine results (25:16)
-
Summary (2:29)
-
Bonus content
UI/UX Writing
-
Welcome (4:53)
-
Definitions - What is UX and UI? (6:51)
-
Messaging components (8:52)
-
Messaging states (11:04)
-
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)
-
Final project
Technical copywriting training course
-
Getting Started (14:47)
-
Overview of marketing (72:14)
-
The copywriting framework (57:42)
-
Planning and writing multiple page copy (28:07)
-
Writing techniques (55:45)
-
Copy examples (1:13)
-
The content brief (5:39)
-
Measuring your performance (4:56)
-
Planning (2:21)
-
Troubleshooting (1:45)
-
Summary (2:23)
-
Answers
Creating screenshots and images for user guides
Creating API documentation and developer portals
-
Introduction (4:52)
-
What is an API? (23:39)
-
Using an API (23:28)
-
How APIs are created (1:24)
-
Authentication and accreditation (17:53)
-
What documentation should I write? (17:12)
-
The Overview section (7:04)
-
The Concepts section (2:16)
-
The Getting Started section (5:43)
-
The API Reference section (2:20)
-
Writing the API reference by hand (12:31)
-
Cookbooks (3:46)
-
Tutorial/Colab/Code labs (3:27)
-
One-pagers (1:23)
-
The Case Study section (2:21)
-
The FAQs/Troubleshooting section (2:08)
-
Cheat sheets (2:25)
-
Release notes (Changelog) (2:22)
-
Other content (3:13)
-
Onboarding (2:11)
-
Writing code samples (5:56)
-
Documentation - summary (1:18)
-
Design patterns in developer portals (14:52)
-
Authoring tools for API documentation (37:33)
-
Managing an API documentation project (17:53)
-
Summary (2:58)
Audio-only content
End of course
