Documentation as Code

Download SKILL.mdGet Murage How skills work

Open source. macOS, Windows and Linux.

At a glance

What it is

Treating documentation as a first-class engineering artifact with docs-in-repo workflows, automated generation, living documentation, testing, and continuous publishing pipelines.

A skill is a written procedure a bot loads when a job calls for it. This one is a single file, SKILL.md, and the whole file is on this page.

File: SKILL.md
Length: 462 lines2,200 words, about 10 min read
Category: Software engineeringdeveloper tools
Level: Beginner
License: Apache-2.0

More software engineering skills.

The full skill.

The whole file, exactly as it downloads. Read it before you rely on it.

SKILL.md

462 lines · 2,200 words

Download

Documentation as Code

You are an expert in documentation-as-code practices. Build documentation systems where docs live alongside code, are version-controlled, reviewed in pull requests, tested in CI, and published automatically. Documentation that is separated from code rots. Documentation that is part of the development workflow stays alive.

Questions to Ask First

Before establishing a documentation-as-code practice, understand the landscape:

What documentation exists today and where does it live?

Put this skill to work.

Questions.

What is the Documentation as Code skill?

Treating documentation as a first-class engineering artifact with docs-in-repo workflows, automated generation, living documentation, testing, and continuous publishing pipelines.

How much does it cost?

Nothing. It ships with Murage, which is open source. Your bots run on the AI plan you already have.

Can I change it?

Yes. Open it in Settings → Skills to read, edit or duplicate it. Skill Guard scans it again after every edit.

Give your first job to Murage.

Download the app, connect the AI you already pay for, and tell your Chief of Staff what needs doing. Plan on about ten minutes from install to a working team.

Download Murage

No account needed · Runs on the AI plan you already pay for

Documentation as Code

More software engineering skills.

The full skill.

Documentation as Code

Questions to Ask First

Put this skill to work.

Questions.

Give your first job to Murage.

Documentation as Code

More software engineering skills.

The full skill.

Documentation as Code

Questions to Ask First

Put this skill to work.

Questions.

Give your first job to Murage.

Create a bot and use this skill.

Ask Ember to create the bot

Open the bot’s skills

Find Documentation as Code and switch it on

Ask the bot for the job

About this skill.

Documentation Types and Where They Live

Decision Matrix: What Goes Where

Repository Documentation Structure

Architecture Decision Records (ADRs)

ADR Template

ADR Workflow

Auto-Generated API Documentation

From Code Annotations (JSDoc/TypeScript)

Auto-Generation Approaches

Diagrams as Code

Diagram Tools

Mermaid Diagrams (GitHub-Native)

Example

Edge Cases

Documentation as Code

More software engineering skills.

The full skill.

Documentation as Code

Questions to Ask First

Put this skill to work.

Questions.

Give your first job to Murage.

Search murage.ai

Documentation as Code

More software engineering skills.

The full skill.

Documentation as Code

Questions to Ask First

Put this skill to work.

Questions.

Give your first job to Murage.

Create a bot and use this skill.

Ask Ember to create the bot

Open the bot’s skills

Find Documentation as Code and switch it on

Ask the bot for the job

About this skill.

Documentation Types and Where They Live

Decision Matrix: What Goes Where

Repository Documentation Structure

Architecture Decision Records (ADRs)

ADR Template

ADR Workflow

Auto-Generated API Documentation

From Code Annotations (JSDoc/TypeScript)

Auto-Generation Approaches

Diagrams as Code

Diagram Tools

Mermaid Diagrams (GitHub-Native)

Example

Edge Cases