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
Ubuntu Linux Server BasicsUdemy Learn DevOps with Jenkins All in One Guide
Udemy Internet and Web Development Fundamentals
Udemy Learning Linux with Ubuntu and CentOS: The Easy Way
Udemy Linux Fundamentals for IT Professionals using Ubuntu 20x
Udemy