doc-author

Draft and update Markdown or MDX docs and open pull requests for review.

427|237|Updated Mar 23, 2023
One-click install
npx skills add https://github.com/mintlify/docs --skill doc-author
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-author
Source: https://github.com/mintlify/docs/tree/main/.claude/skills/doc-author
Command: npx skills add https://github.com/mintlify/docs --skill doc-author

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables you to author and maintain documentation without micromanagement by automatically drafting content, updating pages, and initiating PRs for review.

Core Features & Use Cases

  • Autonomous content generation: create new pages, update existing guides, and align with style guides.
  • PR-driven workflow: automatically opens pull requests for reviewer feedback.
  • Style and consistency: follows project voice, terminology, and formatting patterns across Markdown/MDX docs.
  • Use Case: When onboarding a new feature, generate a complete doc draft and submit it for review.

Quick Start

To begin, prompt the skill with the requested topic and provide any needed code references or product notes. The system will draft the content, compare with existing pages, and open a PR for review.

Frequently Asked Questions about doc-author

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

FAQPage Schema
How do I automate documentation updates and submit them as a PR?

You can automate documentation updates by assigning the skill to draft or revise content; it generates Markdown or MDX pages and automatically opens a pull request for human review.

What is autonomous doc authoring for Markdown and MDX files?

Autonomous doc authoring automatically drafts new pages, updates existing guides, and aligns content with style guides without micromanagement, handling Markdown and MDX formats.

Can I generate API references and onboarding tutorials automatically?

Yes, you can generate API references, guides, tutorials, and onboarding content automatically by prompting the skill with the requested topic and any needed code references.

Does the doc-authoring skill enforce Mintlify writing standards?

Yes, the doc-authoring process enforces verifiability and adheres to Mintlify writing standards, ensuring terminology, voice, and formatting consistency across submitted documentation.

What do I need to provide to draft new feature documentation?

To draft new feature documentation, you need to provide the requested topic along with any needed code references or product notes for the system to generate a complete draft.

When should I use an autonomous PR workflow for documentation?

Use an autonomous PR workflow for documentation when onboarding new features or updating guides, allowing the system to draft content and submit it for reviewer feedback.