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

YouTube

Developer's Torment - The Documentation

Devoxx via YouTube

Overview

Explore the challenges and solutions surrounding software documentation in this insightful conference talk from Devoxx Poland 2019. Delve into the common pitfalls of inadequate documentation, including reliance on tribal knowledge and outdated information. Learn strategies for creating and maintaining effective documentation that serves as a valuable asset rather than a burden. Discover tools and techniques to improve the onboarding process, enhance knowledge sharing, and overcome the frustrations often associated with poor documentation practices. Gain insights on balancing quality over quantity, implementing ubiquitous language, and addressing architecture decisions. Examine the importance of code perspective, uncertainty principles, and discoverability in documentation. Explore various documentation types, consistency measures, and user experience considerations to create truly useful and maintainable documentation for software projects.

Syllabus

Introduction
Context
Confusion
Ubiquity language
Architecture
Architecture Decisions
Desi
Options table
Code perspective
Uncertainty principle
Discoverability
Types
Consistency
User Experience
Questions

Taught by

Devoxx

Reviews

Start your review of Developer's Torment - The 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.