Creating Effective Technical Tutorials - Documentation Office Hours
Offered By: Ubuntu OnAir via YouTube
Course Description
Overview
Join a live recording from Madrid featuring technical authors from Canonical as they discuss approaches to writing effective tutorials. Learn about scope definition, avoiding common pitfalls, and planning strategies. Explore key questions such as when documentation requires a tutorial, whether tutorials should contain unique information, integrating basic and advanced tutorials, syncing tutorial content, and organizing tutorials of varying difficulty levels. Gain valuable insights into technical writing and documentation best practices from experienced professionals in this 18-minute session, part of the weekly Documentation Office Hours series by Ubuntu OnAir.
Syllabus
Introduction
Let's create a tutorial
Scope definition
Avoiding pitfalls
Final plans
Questions
At what stage does a set of documentation need a tutorial?
Should a tutorial contain details not documented elsewhere?
How do you integrate basic and advanced tutorials?
How do you sync tutorial content?
Is it safe to have both basic and advanced tutorials in the same section?
Taught by
Ubuntu OnAir
Related Courses
Social Media in Public RelationsNational University of Singapore via Coursera How to Develop Your Social Media Content Strategy
Institute of Data & Marketing via FutureLearn Create an Editorial Content Calendar in Google Sheets
Coursera Project Network via Coursera Instagram Marketing 2020-21: Advanced Master Course (LATEST)
Udemy Introduction to Social Media Strategy
LinkedIn Learning