Skip to main content

No more broken docs: keep docs accurate with Doc Detective

K.4.201 | Day 1 | 13:00 - 13:30 | Speakers: Ariel Kaiser, Jake Cahill

No more broken docs: keep docs accurate with Doc Detective
A picture of a devroom at FOSDEM 2024
Open in browser
Get involved in the conversation!Join the chat

Notes

Abstract

Documentation often struggles to keep up with development cycles. Your users become testers of inaccurate information, which leads to a poor experience. But what if you could test your documentation for accuracy and catch breaking changes before your users do?

This short talk shows how you can improve your docs-as-code workflows with automated testing. Attendees will hear an explanation of Doc Detective and its testing framework. We will also show off some implementation strategies and automation to help keep your docs current.

Attachments

Speakers

Ariel Kaiser
Jake Cahill

Notice: The placeholder video image is licensed under CC BY-SA 4.0. The original image can be found hereChanges made to the image are: Cropped the image to a new ratio, part of the image was cut off.