Autoplay
Autocomplete
Previous Lecture
Complete and Continue
How to Write Software Documentation
Introduction
What is Technical Writing? (4:58)
How to Use This Course
Basics of Technical Writing - Terminology (8:42)
Principles of Technical Writing (24:57)
Principles of Technical Writing - Exercise (1:27)
Targeting Content for Users - Webinar Reply (64:42)
Targeting Content for Users (11:20)
Software Documentation Development
Understanding Structured Writing (21:28)
What is DITA? (2:43)
Concept, Task, Reference (3:05)
Writing Standards and Guidelines (16:46)
Content Management System (CMS) (7:42)
Checklist for Creating Documentation
Installing Oxygen Author Tool (3:35)
Writing Your First DITA Documentation Using Oxygen Author Tool (5:30)
Exercise: Writing Documentation using Oxygen Author DITA CMS
Working with Images
Writing Documentation in GitHub Wiki
Getting Started with GitHub Wiki (2:39)
What is Covered in this Section? First Exercise! (17:11)
Writing Documentation in GitHub (12:09)
Benefits from Working in this Section on GitHub (7:30)
Strategies and Information Architecture
What is Information Architecture? (1:40)
Who is an Information Architect? (3:35)
Why Should I Care About Information Architecture? (2:57)
Information Architecture in Technical Writing (3:28)
How to Apply Information Architecture Principles for the Content? (12:19)
Structuring Data. Metadata and Taxonomies. (0:35)
What is Metadata? (1:27)
What is Taxonomy? (3:04)
Starting the Classification and Engaging Stakeholders (3:42)
Define Scenarios (4:39)
Visualize it! (2:38)
Congratulations!
Congratulations! (0:41)
Course Evaluation
Course Evaluation
Writing Your First DITA Documentation Using Oxygen Author Tool
Lecture content locked
If you're already enrolled,
you'll need to login
.
Enroll in Course to Unlock