André Dietrich & Jihad Hyadi

Why Is Software Documentation Still Static – And Why Modern Browsers Deserve Better

What if your documentation wasn't just static text, but a live, executable environment? This talk shows you how to build it directly in the browser.

Why Is Software Documentation Still Static – And Why Modern Browsers Deserve Better
#1about 7 minutes

Why software documentation remains static and ineffective

The traditional build pipeline for documentation results in a static, fragmented experience that fails to support the interactive way developers actually work.

#2about 3 minutes

Making markdown executable directly in the browser

A new mental model for documentation is demonstrated where Markdown code blocks can be executed live, allowing for immediate experimentation and feedback.

#3about 3 minutes

Capturing console output and handling async code

The interactive environment is extended to capture console log output in a virtual terminal and to correctly handle asynchronous JavaScript functions.

#4about 3 minutes

Embedding interactive data visualizations in documentation

By rendering HTML output from code blocks, you can embed rich data visualizations like interactive charts directly into the documentation using libraries like Chart.js.

#5about 2 minutes

Creating reusable components with macros and imports

Macros and imports are used to abstract away repetitive boilerplate code, enabling the creation of reusable libraries of interactive documentation components.

#6about 6 minutes

Building reactive UIs with first-class script tags

By treating script tags as first-class citizens, you can build reactive UIs with elements like sliders that trigger API calls and update data tables in real-time.

#7about 3 minutes

Adding audio narration and presentation modes

Documentation can be enhanced with text-to-speech narration for code explanations and a presentation mode that turns the document into interactive slides.

#8about 2 minutes

A vision for decentralized educational content

LeoScript enables the creation of serverless, decentralized, and interactive open educational resources (OER) that can be easily shared and remixed.

Related jobs
Jobs that call for the skills explored in this talk.

Featured Partners

Related Articles

View all articles

From learning to earning

Jobs that call for the skills explored in this talk.