doc-helper

Draft and refine Markdown/MDX documentation within Mintlify-powered sites.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill assists humans with writing and improving documentation. It acts as a collaborative writing partner, helping draft content, suggest edits, and refine language while leaving final decisions to humans.

Core Features & Use Cases

  • Drafting content: generate initial drafts based on outlines or briefs.
  • Editing and style alignment: propose tone, clarity, and consistency with existing voice.
  • Review and clarification: ask targeted questions to resolve ambiguities during collaboration.
  • Real-world use: work alongside a documentation author to produce publish-ready pages for Markdown/MDX docs in Mintlify-powered sites.

Quick Start

Draft an introductory section for a new documentation page and propose edits to improve clarity and tone.

Frequently Asked Questions about doc-helper

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

FAQPage Schema
How do I draft and refine Markdown documentation collaboratively?

Draft and refine Markdown documentation collaboratively by generating initial drafts from outlines, proposing edits with rationale, and asking clarifying questions to resolve ambiguities. The assistant preserves your target voice while deferring final decisions to you.

Can I use this to align my writing tone with existing MDX docs?

Align your writing tone with existing MDX docs by having the assistant propose targeted edits for clarity and consistency. It reviews your content and refines the language to match the established voice of your documentation.

Does this documentation assistant work with Mintlify-powered sites?

This documentation assistant works directly with Mintlify-powered sites to help authors produce publish-ready Markdown and MDX pages. It operates as a collaborative partner during content creation and review.

What is the best way to review documentation for clarity and consistency?

The best way to review documentation for clarity and consistency is to use a collaborative assistant that proposes style edits, asks targeted questions to resolve ambiguities, and provides rationale for each suggested change.

Will the assistant automatically publish content changes to my docs?

The assistant will not automatically publish content changes to your docs. It acts as a collaborative writing partner that proposes edits and asks clarifying questions, leaving all final publishing decisions to human authors.