skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
gtmagents/gtm-agents67 installs

api-style-guide

Style and formatting rules for API/SDK documentation, samples, and tutorials.

How do I install this agent skill?

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

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    This skill provides style and formatting guidelines for API and SDK documentation. It contains no executable code, network operations, or sensitive data access.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

  • Runlayerpass

    1 file scanned · No issues

What does this agent skill do?

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.

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/gtmagents/gtm-agents/api-style-guide">View api-style-guide on skillZs</a>