Documentation Courses

Rust for Linux: Code Documentation and Testing - Mentorship Session

Explore Rust for Linux: safety guarantees, documentation practices, and testing methodologies. Learn about code contracts, invariants, and writing effective examples that double as tests.

• YouTube
• 1 hour 27 minutes
• On-Demand
• Free Video

The Cherno

Creating a Documentation Website for a Game Engine

Learn to create a documentation website for a game engine using mdBook, GitHub webhooks, and automated updates for efficient development and maintenance.

• YouTube
• 19 minutes
• On-Demand
• Free Video

Docker

Docs as Code - Managing Documentation with Software Development Practices

Explore the "Docs as Code" approach for efficient documentation management, version control, and collaboration in software development projects.

• YouTube
• 20 minutes
• On-Demand
• Free Video

Ensuring Documentation Is a First-class Citizen in Open Source Projects

Learn strategies to prioritize and improve documentation in open source projects, focusing on its importance, context, contribution methods, and recognition for contributors.

• YouTube
• 27 minutes
• On-Demand
• Free Video

The Julia Programming Language

Survey of the Julia General Registry: Code, Documentation, and Testing

Explore Julia's General registry: package sizes, licenses, docs, tests, CI, and contributors. Learn to analyze packages with PackageAnalyzer.jl for ecosystem insights.

• YouTube
• 25 minutes
• On-Demand
• Free Video

SAP

GitHub Mechanics for the Open Documentation Initiative

Explore automation in GitHub repositories for open documentation, including workflows, linters, and content checkers. Learn to manage contributions and maintain quality in collaborative documentation projects.

• YouTube
• 1 hour 3 minutes
• On-Demand
• Free Video

SAP

Introducing the Open Documentation Initiative

Explore SAP's Open Documentation Initiative, learn about contribution types, GitHub integration, and the process of submitting feedback and content to improve SAP's documentation ecosystem.

• YouTube
• 1 hour 4 minutes
• On-Demand
• Free Video

Caleb Curry

Build a Markdown Documentation Site with Docusaurus

Learn to create a Markdown documentation site using Docusaurus with step-by-step guidance, covering configuration, homepage setup, styling, building, and testing.

• YouTube
• 26 minutes
• On-Demand
• Free Video

EuroPython Conference

Sphinx Autodoc - Automated API Documentation

Learn to automate API documentation using Sphinx autodoc and related extensions. Discover techniques for efficient docstring writing, automated module listing, coverage checking, and doctest verification to create comprehensive Python library documentati…

• YouTube
• 36 minutes
• On-Demand
• Conference Talk

EuroPython Conference

Writing Multi-Language Documentation Using Sphinx

Learn techniques for creating multi-language documentation with Sphinx, including tools, workflow organization, and best practices based on real-world project experiences.

• YouTube
• 25 minutes
• On-Demand
• Conference Talk

PyCon US

Automate Documentation with Sphinx & GitHub Actions

Learn to create, generate, host, and automate up-to-date API documentation using Sphinx and GitHub Actions, integrating it seamlessly into your software development lifecycle.

• YouTube
• 46 minutes
• On-Demand
• Conference Talk

Spring I/O

Test-Driven Documentation with Spring REST Docs

Explore Spring REST Docs for accurate, test-driven API documentation. Learn to combine Asciidoctor with integration tests, keeping code DRY and enhancing readability. Discover new features in version 1.1.

• YouTube
• 52 minutes
• On-Demand
• Conference Talk

Devoxx

Coding Your Documentation

Learn to create dynamic, code-driven documentation that stays up-to-date with your project, enhancing maintainability and accuracy for developers and users alike.

• YouTube
• 45 minutes
• On-Demand
• Conference Talk

linux.conf.au

Taking a Step Back - Analysing Your Documentation

Learn to analyze and improve your documentation by taking a step back, assessing your current state, identifying gaps, and aligning with user needs for more effective technical writing.

• YouTube
• 37 minutes
• On-Demand
• Conference Talk

linux.conf.au

No Docs? No Problem! - From Zero to Full Documentation in Less Time than You Think

Practical guide to developing comprehensive technical documentation for mature codebases efficiently, covering strategies, benefits, and lessons learned from the HarfBuzz library project.

• YouTube
• 43 minutes
• On-Demand
• Conference Talk