mcpField
A
api-style-guide

api-style-guide

github.com/gtmagentsDevelopment42865 installsUpdated 30w ago
Repository

About api-style-guide

A skill for writing and reviewing API documentation, intended for engineers, DevRel teams, and partners. It sets conventions for structure, terminology, code samples, metadata, accessibility, and localization to support consistency.

Key features

  1. 01Language, tone, and terminology rules
  2. 02Endpoint structure and formatting conventions
  3. 03Code sample and authentication checks
  4. 04Version and availability metadata
  5. 05Accessibility and localization guidance

Use cases

  1. 01Write or update API references and tutorials
  2. 02Review documentation contributions from engineers or partners
  3. 03Check documentation consistency before releases

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/gtmagents/gtm-agents --skill api-style-guide

After installing, type/api-style-guidein Claude Code to confirm it loaded.

Details

From the project README

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.

Comments

Markdown supported