Reimagined Engineering Docs with Runme.dev

Audience:
Topic:

In today's world, we have advanced tools for testing, building, and deploying applications, yet internal engineering documentation remains stuck in outdated practices like copy-pasting from wikis. To fix this, we need to rethink how documentation works, focusing on system dependencies, environment configs, cloud integration, and human-readable explanations. Drawing inspiration from literate programming (1984) and Jupyter Notebooks, Runme (runme.dev) introduces a new approach to Runbooks, playbooks, and onboarding docs—turning Markdown into interactive Notebooks and providing a TUI for hands-on experience.

Runme streamlines the complexity of engineering documentation by addressing key challenges: 

  • Automated testing for docs in CI
  • Leveraging DevContainers to make doc deps reliable
  • Handling config/secrets deps with typed .ENV files
  • Integrating cloud-native tooling into docs

In just minutes, engineers can create interactive, reliable, and fully integrated docs, transforming how teams manage their internal processes.

Time:
Tuesday, September 10, 2024 - 10:30