This course was created with the
course builder. Create your online course today.
Start now
Create your course
with
Autoplay
Autocomplete
Previous Lesson
Complete and Continue
How to Write Software Documentation
Getting Started
Introduction (5:43)
Course Materials to Download
Course Evaluation
Getting Started with Technical Writing
What is technical writing? (2:28)
Technical Communications (6:06)
Technical Writing as a Skill (2:06)
The Job of the Technical Writer (3:29)
Common Types of Documentation (0:50)
Functional Documentation (4:23)
Example - Functional Documentation (2:07)
Strategy for Writing Functional Documentation (1:28)
Task Oriented Documentation (10:22)
Strategy for Writing Task Oriented Documentation (7:49)
Exercise: Write Task Oriented Documentation (1:21)
Documentation Process Flow - Summary (14:49)
Writing Software Documentation Using Markdown in GitHub Wiki
Learn to Write Software Documentation Using Markdown in GitHub Wiki (2:03)
Technical Writers in the Software Development World (7:11)
Technical Writers in the Software Development World (4:43)
What is GitHub? (4:06)
Why GitHub? (2:05)
Documentation in GitHub (3:55)
Markup Language (1:02)
Instructor Examples (4:03)
Exercises in This Course Section (3:35)
Create a New Repository in GitHub (1:42)
Demo: Creating a New Wiki Page and Basic Formatting (6:53)
Create a Table in GitHub (7:06)
Uploading Files and Images (4:47)
Create a Mail Link (2:51)
Create Table of Contents (TOC) in Wiki (6:13)
Create a Link to YouTube Video (5:59)
Demo (3:42)
Structured Writing in GitHub Wiki Environment (0:48)
What will you learn? (0:14)
Why do we Need Structure in Writing? (2:55)
Organize Content (0:26)
Consistent UX (0:39)
Intuitive Experience (1:15)
Completeness of Documentation (0:48)
Targeting Content (0:37)
Projects Coordination (0:30)
Efficiency (0:09)
Structured Writing - Definition (5:59)
Common Information Types (0:40)
DITA XML Standard (6:09)
How to Structure in an Unstructured Writing Environment? (0:31)
Structured Writing in GitHub Wiki (3:46)
Instructor Examples (5:27)
Templates - Explained - Task and Concept (10:12)
Templates - Explained - Reference (4:47)
Demo (3:11)
Ideas for Organizing Your Own Portfolio (6:06)
Graphics in Software Documentation
Before We Start... (2:42)
Graphics in Software Documentation (1:22)
When to Use Graphics? (4:02)
Types of Graphics in Software Documentation (4:56)
Tools for Creating Graphics (1:13)
Microsoft PowerPoint (5:39)
diagrams.net (8:08)
canva.com (13:17)
Information Architecture Basics
Information Architecture for Technical Writers (0:13)
What Will You Learn in This Section? (1:01)
What is Information Architecture? (3:24)
User Experience (UX) and Information Architecture in Technical Writing (6:09)
User Research and Analysis (0:27)
Knowing the User (2:42)
Deliverables and Delivery Channels (0:50)
Research (5:15)
Delivery (3:11)
Content Modeling (3:11)
Using the Data (3:27)
Using Cards Sorting in User Research (0:12)
What is Cards Sorting? (1:28)
Benefits of the Cards Sorting Technique (4:27)
Open Cards Sorting (5:45)
How to Set it Up? (3:32)
Demo: Open Card Sorting Using Mural (8:25)
Instructor's Second Example (1:31)
Closed Cards Sorting (4:16)
How to Set it up? Demo in Mural (6:18)
Instructor's Example (0:34)
Mural as a Tool for Cards Sorting (0:29)
Quality in Software Documentation
Defining the Meaning of Quality in Documentation (3:03)
What Will You Learn? (1:02)
A Definition of "Quality" (1:03)
What is "Quality" in Software Documentation? (1:26)
The Research (1:34)
The Results (2:44)
What Did People Answer? (0:46)
The Framework - Overview (1:55)
Helpful (2:25)
Comprehensive (2:45)
Searchable (4:37)
Visual (4:42)
Usable (3:48)
Reliable (2:48)
Grammatically Correct (1:24)
Translatable and Localization Friendly (1:15)
Accessible (2:21)
Using Appropriate Tone (2:02)
How to Use the Results from the Research? (1:03)
Learn to Write Software Documentation Using Markdown in GitHub Wiki
Complete and Continue