# API Style Guide > Style and formatting rules for API/SDK documentation, samples, and tutorials. Use when this capability is needed. - Skill: `tomevault-io/api-style-guide` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/api-style-guide` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/api-style-guide/raw - Safety review: pending - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Marketing & Growth - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/api-style-guide --- # API Style Guide Skill ## When to Use - Authoring or updating API references, tutorials, and SDK docs. - Reviewing contributions from engineers, DevRel, or partners. - Auditing docs for consistency before releases. ## Framework 1. **Language & Tone** – audience-specific tone, terminology list, and banned phrases. 2. **Structure** – endpoint/order conventions, table layouts, code block formatting, error doc patterns. 3. **Code Samples** – naming standards, authentication handling, pagination patterns, inline comments. 4. **Metadata & Tags** – version labels, availability notes, beta flags, locale indicators. 5. **Accessibility & Localization** – heading hierarchy, alt-text, snippet annotations, translation guidance. ## Templates - Reference entry template (description, parameters, responses, examples, notes). - Tutorial skeleton with prerequisites, steps, troubleshooting, next steps. - Code sample checklist ensuring env vars, comments, and error handling are included. ## Tips - Keep examples runnable; provide curl equivalents even when primary sample is in another language. - Link to glossary for shared terminology across teams. - Pair with `update-api-reference` command to enforce consistent output. --- --- > Converted and distributed by [TomeVault](https://tomevault.io/claim/gtmagents) — claim your Tome and manage your conversions.