document

Generates Diátaxis-aligned technical documentation grounded in codebase research with an automatic naturalize pass.

2|Updated Apr 4, 2026
One-click install
npx skills add https://github.com/DoctorMozg/claude-pipelines --skill document-doctormozg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/DoctorMozg/claude-pipelines/tree/main/plugins/mz-creative/skills/document
Command: npx skills add https://github.com/DoctorMozg/claude-pipelines --skill document-doctormozg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing accurate technical documentation requires deep knowledge of the actual codebase, and AI-generated docs often invent API signatures or carry robotic prose patterns. This Skill grounds every document in real code research and removes residual AI writing patterns before delivery. ## Core Features & Use Cases - Codebase-grounded research: Scans manifests, public APIs, CLI entry points, routes, and existing docs to build a factual research base before any writing begins. - Diátaxis-structured output: Produces tutorials, how-tos, references, explanations, READMEs, or API docs following the Diátaxis framework, with an approval gate before writing starts. - Automatic naturalize pass: Runs a dedicated rewriting agent to strip AI writing patterns while preserving code blocks, tables, and API names. - Use Case: Ask it to "write API reference for the payments module" and it researches the module's exported functions, proposes a doc structure for your approval, writes the reference, and delivers a polished Markdown file under .mz/reports/. ## Quick Start Ask the assistant to write docs for a specific module or polish an existing README, optionally adding a scope or type modifier such as scope:branch or type:tutorial.

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate technical documentation from my codebase automatically?

Invoke the document skill with a brief describing what to document, such as a module or feature. It researches the codebase first, presents a structure for approval, then writes and naturalizes the document into a Markdown report.

What is the Diátaxis framework for documentation?

Diátaxis splits documentation into four types: tutorials, how-to guides, reference, and explanation. This skill uses the type: modifier to target one type or produce a multi-type document with labeled sections.

Can I polish an existing README instead of writing new docs?

Yes, pass the existing file with the @doc: modifier, for example @doc:README.md. The research phase then proposes what to keep, change, or split, and the writer rewrites it in polish mode.

How do I limit documentation research to changed files?

Use the scope:branch modifier to restrict research to files changed on the current branch, or scope:working for uncommitted changes. The default scope:global researches the entire repository.

What happens if the documentation writer agent gets blocked?

The orchestrator re-dispatches the writer once with the missing context filled in. If it remains blocked, the skill escalates to you with options to write a partial document or abort the task.

When should I not use an automated documentation pipeline?

Avoid it for marketing or promotional copy, pure AI-text rewrites of existing prose, or code review tasks. Those cases are handled by separate copywrite, naturalize, and review skills.