doc-write

Estrelas0

Forks1

Atualizado1 de junho de 2026 às 07:03

Create, write, or update documentation pages in a Mintlify-based docs site. Use when the user wants to write docs, create a new page, document a feature, add a guide or tutorial, or update existing documentation. Do NOT use for reviewing or auditing — use doc-review for that. Triggers on "write docs for X", "create a new page", "document this feature", "add a tutorial", "draft a how-to guide".

Instalação

Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.

Executar no Manus

Fonte

kosli-dev

kosli-dev/docs

Abrir repositório GitHub Ver repositórios do creator

Download

Executar no Manus

Ocupações relacionadasSOC

Baseado na classificação ocupacional SOC

Redatores técnicosArtes, Design, Entretenimento, Esportes e Mídia·SOC 27-3042

SKILL.md

readonly

Mais deste repositório

mesmo repositório

doc-review

kosli-dev/docs

Review documentation for quality, structure, and convention compliance. Use when the user wants to review docs, audit a page or section, check if content is clear, evaluate information architecture, or assess navigation. Do NOT use when the user wants to write or fix docs — use doc-write for that. Triggers on "review the docs", "audit this page", "is this getting-started page clear", "check the implementation guide section".

2026-06-010

name	doc-write
description	Create, write, or update documentation pages in a Mintlify-based docs site. Use when the user wants to write docs, create a new page, document a feature, add a guide or tutorial, or update existing documentation. Do NOT use for reviewing or auditing — use doc-review for that. Triggers on "write docs for X", "create a new page", "document this feature", "add a tutorial", "draft a how-to guide".

Doc Write

Author Mintlify docs pages following the Diátaxis framework and the project's CLAUDE.md.

Before writing

Read the project's CLAUDE.md — it defines all site-specific conventions (components, writing style, link format, frontmatter, don'ts). Follow it exactly. If no CLAUDE.md exists, read 3-4 existing pages to infer conventions.
Read docs.json to understand navigation structure.
Read 2-3 similar pages to match the site's voice, structure, and component usage.
Search for existing content using Grep and Glob — you may need to update rather than create.

Classify the doc type (Diátaxis)

Every page must fit one of these four types. Classify before writing:

Type	Purpose	User need	Structure
Tutorial	Learning-oriented	"Teach me X"	Step-by-step guided learning experience with expected outcomes
How-to guide	Task-oriented	"How do I do X?"	Goal-focused steps, assumes knowledge, handles variations
Reference	Information-oriented	"What is X?"	Complete, accurate, terse technical description
Explanation	Understanding-oriented	"Why does X work this way?"	Context, background, trade-offs, alternatives

A common mistake is mixing tutorials with how-to guides — tutorials teach through doing, how-to guides solve specific problems. If the doc type is ambiguous, ask the user.

Writing process

Classify the doc type and confirm with the user if uncertain.
Outline the page structure based on the doc type.
Write the MDX file following the project's CLAUDE.md conventions.
Place the file in the correct directory and update config/navigation.json (or docs.json navigation, whichever the project uses).

Output

Write files directly to disk using Write/Edit tools. Then report:

File path of the created/updated page.
Navigation entry added (path in config/navigation.json or docs.json).
Related pages that should cross-link to this one.