Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

YouTube

Taking a Step Back - Analysing Your Documentation

linux.conf.au via YouTube

Overview

Explore a comprehensive approach to analyzing and improving documentation in this conference talk from linux.conf.au 2021. Learn how to take a step back, assess your current documentation, and develop a strategy for enhancement. Discover techniques for gathering existing materials, understanding your audience, conducting user task analysis, identifying gaps, and aligning documentation with real-world needs. Gain insights on setting realistic deadlines, maintaining flexibility, and initiating the writing process. Equip yourself with practical tools to streamline and optimize your documentation efforts in the context of open-source software development.

Syllabus

Introduction
Gather the goods
Think about your readers
User task analysis
Finding the gaps
Dream match reality
Set a deadline
Be flexible
Start writing
Questions

Taught by

linux.conf.au

Reviews

Start your review of Taking a Step Back - Analysing Your Documentation

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.