Documentation Courses

Continuous Documentation Manifesto

Explore a new paradigm for creating and maintaining code documentation, integrating it into the development workflow to improve team efficiency and productivity.

• YouTube
• 18 minutes
• Self-Paced
• Conference Talk

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
• Self-Paced
• 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
• Self-Paced
• 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
• Self-Paced
• Conference Talk

PyCon US

Iteration Toward Transformation of the Python Documentation

Discover the Python Docs Community's efforts to enhance Python's documentation, including key improvements, insights, and ways to contribute to this initiative for better serving diverse users.

• YouTube
• 37 minutes
• Self-Paced
• Conference Talk

PyCon US

Localize Your Open Source Documentation - A Kubernetes Case Study

Scaling open source documentation localization: Kubernetes' journey from zero to eleven languages, covering tools, workflows, standards, and community conduct for successful project localization.

• YouTube
• 26 minutes
• Self-Paced
• Conference Talk

PyCon US

Writing Good Documentation for Developers

Learn to create effective developer documentation that serves as marketing, defines your product, and acts as a user interface. Discover key strategies for different doc types and user engagement.

• YouTube
• 23 minutes
• Self-Paced
• Conference Talk

Ubuntu OnAir

Free Software and Open Source Licenses - Documentation Office Hours

Explore open source licenses, their implications for documentation and code contributions, and key concepts like copyleft, four freedoms, and permissive vs. restrictive licenses.

• YouTube
• 24 minutes
• Self-Paced
• Free Video

Ubuntu OnAir

Text Editor Tour - Documentation Office Hours

Explore popular text editors for various writing needs, from feature-rich IDEs to distraction-free tools. Learn about their unique features and find the perfect editor for your workflow.

• YouTube
• 20 minutes
• Self-Paced
• Free Video

Ubuntu OnAir

Documentation Office Hours: GitHub Workflow for Ubuntu Documentation - March 8, 2024

Live demonstration of GitHub workflow for documentation tasks, including forking, cloning, branching, editing, committing, pushing, and creating pull requests.

• YouTube
• 23 minutes
• Self-Paced
• Free Video

Ubuntu OnAir

Documentation Office Hours - Git Tools and GitHub Demos

Live session exploring GitHub features and git GUI tools, with demos of Lazygit, gitui, and tig. Includes updates on documentation and celebrates first-time contributors.

• YouTube
• 35 minutes
• Self-Paced
• Free Video

Towards Great Documentation: Behind a CNCF-Led Docs Audit

Insights into improving open-source documentation, based on CNCF's audit of Backstage docs. Learn actionable strategies for creating better, more user-friendly project documentation.

• YouTube
• 33 minutes
• Self-Paced
• Free Video

Reimagining Knative - A Case Study on Improving Documentation Through Design

Discover how designers improve open-source documentation through user experience research methods, focusing on Knative's website navigation enhancements and accessibility improvements.

• YouTube
• 38 minutes
• Self-Paced
• Free Video

Devoxx

From RAGs to Riches - Making Sense of Your Documentation with LLMs

Explore how retrieval augmented generation (RAG) enhances LLMs, enabling domain-specific chatbots to efficiently navigate and utilize internal documentation for improved information retrieval.

• YouTube
• 18 minutes
• Self-Paced
• Conference Talk

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
• Self-Paced
• Free Video