skills.rest
gocobalt
gocobaltOFFICIAL
Explore all skills by this author →
WebsiteGitHub

doc-author

Write, edit, and maintain documentation for Mintlify sites with PR-based review.

1|1|Updated Sep 28, 2023
Search Tags:#documentation#writing#collaboration#autonomy#pull-request#documentation-maintenance
One-click install
npx skills add https://github.com/gocobalt/mintlify-docs --skill doc-author-gocobalt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-author
Source: https://github.com/gocobalt/mintlify-docs/tree/main/.agents/skills/mintlify/.claude/skills/doc-author
Command: npx skills add https://github.com/gocobalt/mintlify-docs --skill doc-author-gocobalt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation tasks across teams can be slow and inconsistent; this skill helps you write, edit, and maintain documentation with flexible modes for collaboration or autonomous updates.

Core Features & Use Cases

  • Collaborative drafting with human review and rationale for changes.
  • Autonomous writing with PR-based updates and explicit TODOs for verification.
  • Guidelines to maintain consistent voice, structure, and publish-ready docs.
  • Use Case: onboard new docs, refresh outdated pages, or convert drafts into publishable content.

Quick Start

Provide a description of your documentation task and specify whether to draft collaboratively or autonomously.

Frequently Asked Questions about doc-author

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

FAQPage Schema
How do I write and maintain documentation for a Mintlify-powered site?▼

Documentation for a Mintlify-powered site is written and maintained by ensuring frontmatter presence, MDX compatibility, and consistent voice. The skill switches between collaborative drafting and autonomous writing modes to produce publish-ready pages.

Can I autonomously update documentation and review it through a pull request?▼

Yes, autonomous documentation updates use PR-based review to track changes. The skill generates explicit TODOs for verification, allowing you to review and approve autonomous writing before merging content into your docs.

What is the best way to collaboratively draft technical documentation with a team?▼

Collaborative drafting is handled by applying human review and rationale for changes to maintain consistency. This approach helps teams onboard new docs, refresh outdated pages, and convert drafts into publish-ready content.

Does this documentation writer ensure MDX compatibility and frontmatter presence?▼

Yes, the documentation writer applies guardrails for quality and consistency by ensuring frontmatter presence and MDX compatibility. This prevents formatting errors and maintains structure across all pages.

When should I use autonomous writing versus collaborative drafting for documentation maintenance?▼

Use autonomous writing for routine documentation maintenance updates reviewed via PR, and switch to collaborative drafting when onboarding new docs or converting drafts that require human rationale and review.

Related Skills

Explore More Content & Communication Skills→
githubnextgithubnext
4.9k

documentation

Generate Diátaxis documentation with Astro Starlight MDX components and frontmatter metadata.

Official
Basic
WellDunDunWellDunDun

mintlify

Automate Mintlify documentation site creation and maintenance with MDX and docs.json.

Community
Intermediate
QventuQventu

mintlify

Creates and maintains Mintlify documentation sites using CLI, MDX frontmatter, and docs.json.

Official
Intermediate
rochacbrunorochacbruno
866

marmite

Convert markdown files into complete static websites without manual configuration.

Community
Intermediate