Documentation Courses

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

NDC Conferences

The Art of Documentation and Readme.md

Learn how small changes to an open-source README can welcome users and contributors and help them get started.

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

Circuit Dojo

Zephyr 101 - Documentation with Doxygen

Learn to generate comprehensive API documentation for Zephyr projects using Doxygen, enhancing code readability and collaboration.

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

UbuCon Asia

A Quick Guide to Contribute to Open Source Documentation

Learn essential strategies for contributing to open source documentation, enhancing your skills and making meaningful impacts in the community.

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

KVM Forum

QEMU: Understanding QMP, QAPI, and API Documentation with Sphinx

Explore QEMU's QMP and QAPI, unraveling their differences and recent developments. Learn about the QMP documentation overhaul project and its impact on developers and users.

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

DevConf

Documentation and AI: A Match Made in Heaven or Hell?

Explore the impact of AI on software documentation, weighing pros and cons of LLMs in tech writing. Learn best practices for AI-assisted documentation and share experiences.

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

The Julia Programming Language

Writing and Maintaining Exceptional Documentation - JuliaCon 2024 Workshop

Learn to create stellar documentation for your Julia codebase. Master core principles, write effective docstrings, and use Documenter.jl to generate and deploy professional-quality docs online.

• YouTube
• 2 hours 55 minutes
• Self-Paced
• Free Video

Ubuntu OnAir

Markdown vs reStructuredText vs AsciiDoc vs XML - Comparing Documentation Markup Languages

Comprehensive comparison of popular markup languages for technical documentation, exploring their strengths, weaknesses, and use cases to help choose the right tool for your project.

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

PyCon US

Making Your Documentation Interactive with PyScript

Enhance Python documentation with interactive examples using PyScript, enabling users to run code directly in web browsers without installation or backend setup.

• YouTube
• 30 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

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

echohive

GPT-4 Turbo Documentation Converter to JSON Format

Convert documentation into easily chunkable JSON format using GPT-4 Turbo, enhancing retrieval accuracy. Explore basic to advanced implementations and iteratively improve generated documentation for better searchability.

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

Keith Galli

Creating and Deploying a Python API with Interactive Documentation

Learn to create, document, and deploy Python APIs using Flask and Flasgger. Covers GET requests, cloud deployment, and interactive documentation, with practical examples and deployment on Render.com.

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

GeeCON Conference

The Emperor Has No Docs - Importance of Software Documentation

Discover the importance of documentation in software development through board game analogies and practical tips for creating effective, time-saving docs for various audiences.

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

EuroPython Conference

An Alternative View on OpenAPI Documentation

Explore an innovative approach to auto-generating API documentation, addressing challenges in readability, versioning, and authentication for improved usability of OpenAPI specs.

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