Developer docs skills index
Skills for writing and maintaining docs.zapier.com (public-api-docs).
These skills are universal — they apply across every section (integrations, SDK, MCP, Powered by Zapier, white-label). There are no per-product skills. They are also tool-agnostic: authored in .cursor/skills/ and mirrored to .claude/skills/ via pnpm run sync-skills, so Cursor and Claude users share one source of truth.
Skills live as flat folders directly under .cursor/skills/. They are organized by the category tag in each description ([Foundational], [Template], [Reference], [Workflow], [Meta]), the template-* naming prefix, and the sections below — not by directory nesting (Claude only discovers top-level skill folders).
How to use this index
- Starting a contribution? Begin with the contribute-docs workflow.
- Writing content? Apply the Foundational skills, and pick the right page type with dev-doc-types.
- Creating or editing a skill? Use create-edit-skills.
Foundational skills
Always apply when writing or editing any page.| Skill | Description |
|---|---|
| writing-standards-dev-docs | Voice and tone, sentence case, negative contractions, em-dashes and punctuation, active voice, plain language, headings, steps. |
| accessibility-inclusivity | Authoritative for sensory-neutral language, plus alt text, heading hierarchy, link text, accessible code blocks, and inclusive terminology (allowlist/denylist, main/replica). |
| formatting-guidelines | Mintlify components, frontmatter, snippets, JSX comments, whitespace, generated-file awareness. |
| code-examples | Multi-language <CodeGroup> (cURL → TypeScript → Python), shell conventions, complete-script pattern, runnable and fake-value rules. |
| glossary-terminology | Canonical terms (Zap, app vs integration, Platform UI/CLI) and the one-term-per-concept rule. |
Template skills
Use after choosing a page type with dev-doc-types. Each template carries per-section writing rules plus a starter.mdx skeleton in its assets/ folder.
| Skill | Page type | Use for |
|---|---|---|
| template-tutorial | Tutorial | Learning by building a working example end to end (quick start) |
| template-how-to | How-to | One known task, or resolving an error (error-handling variant) |
| template-concept | Explanation | What something is, how it works, when to use it |
| template-reference | Reference | Factual look-up: errors, limits, states (not OpenAPI endpoint pages) |
Reference skills
Use for guidance on a specific topic.| Skill | Use when |
|---|---|
| dev-doc-types | Choosing a page type (tutorial, how-to, reference, explanation) and structuring it with the agent-readability layer. |
| sdk-content-pipeline | Editing SDK docs: source→output map, regeneration commands, adding code examples, understanding what is generated vs hand-written. |
Workflow skills
Use when performing a multi-step task.| Skill | Description | Trigger |
|---|---|---|
| contribute-docs | End-to-end mechanics: local setup, create a page, register in docs.json, sections, moves/redirects, deprecating a feature, llms.txt, quality checks, MR. | ”Add a page”, “How do I contribute”, “Move this page”, “Open an MR”, “Deprecate this feature” |
| create-new-dev-docs | Draft a brand-new page from a ticket, MR/OpenAPI spec, or feature description: research, page-type selection, drafting from a template, cross-linking, accuracy checks. | ”Create a new page”, “Document this new endpoint/feature” |
| update-existing-dev-docs | Update an existing page: locate it, compare to its template, edit in place with diffs, re-verify accuracy, handle redirects. | ”Update this page”, “Fix this doc”, “This is outdated” |
| review-before-done | Pre-merge quality check calibrated by stakes: accuracy, runnable code, writing standards, structure mechanics, build and links, with a ship-it verdict. | ”Review this”, “Check my work”, “Is this ready to merge?“ |
| request-docs-from-code | Turn an MR, commit, OpenAPI change, or feature description into a docs request or draft (TECHWR ticket, outline, or gap analysis). | ”Document this MR”, “What docs do we need”, “Create a docs request” |
| dev-platform-release-changelog | Generate a release changelog entry in integrations/news/2026/ for a new Zapier Platform version: auto-detect commit range, fetch PR details, categorize changes, produce a formatted .mdx file, and run the render script. | ”Write a changelog”, “Release notes for v18.x”, “Create a Platform release” |
Meta skills
About the skill system itself.| Skill | Use when |
|---|---|
| create-edit-skills | Creating or editing a skill, auditing the system, or updating this index and AGENTS.md. |
Rules (auto-applied in Cursor)
These live in.cursor/rules/ and load automatically when relevant:
| Rule | Applies to |
|---|---|
repo-overview.mdc | Always — repo structure and dev commands |
multi-language-code-examples.mdc | **/*.mdx — CodeGroup requirement |
generated-content-safety.mdc | **/*.mdx — never hand-edit generated files |
Skill relationships
Quick reference
| I want to… | Use this skill |
|---|---|
| Create a new page end to end | create-new-dev-docs |
| Update an existing page | update-existing-dev-docs |
| Review a draft before merging | review-before-done |
| Turn an eng change into a docs request | request-docs-from-code |
| Handle repo mechanics (docs.json, redirects, MR) | contribute-docs |
| Decide what kind of page to write | dev-doc-types |
| Write a tutorial or quick start | template-tutorial |
| Write a task or error-handling guide | template-how-to |
| Write a concept or overview | template-concept |
| Write an errors, limits, or states page | template-reference |
| Get voice, headings, and step rules right | writing-standards-dev-docs |
| Check accessibility and inclusive language | accessibility-inclusivity |
| Add callouts, tabs, accordions, or cards | formatting-guidelines |
| Write multi-language code examples | code-examples |
| Check terminology | glossary-terminology |
| Create or edit a skill | create-edit-skills |
| Write a Platform release changelog | dev-platform-release-changelog |