api-style-guide
Style and formatting rules for API/SDK documentation, samples, and tutorials.
Best use case
api-style-guide is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Style and formatting rules for API/SDK documentation, samples, and tutorials.
Teams using api-style-guide should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/api-style-guide/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How api-style-guide Compares
| Feature / Agent | api-style-guide | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Style and formatting rules for API/SDK documentation, samples, and tutorials.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# 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. ---
Related Skills
37signals-rails-style
Apply 37signals/DHH Rails conventions when writing Ruby on Rails code. Use when building Rails applications, reviewing Rails code, or making architectural decisions. Covers various aspects of Rails application architecture, design and dependencies.
eos-style
Strunk & White style review using the 21 reminders from "Elements of Style" Chapter V. Use when editing prose, reviewing drafts, or improving writing clarity and tone.
academic-writing-style
Personalized academic writing assistant for university assignments in Chinese and English. Use when users need help writing/revising academic reports, project docs, technical analyses, research reviews, or case studies. Produces natural prose avoiding AI markers. Triggers: academic writing, assignment, report, technical analysis, research review, case study. | 个性化学术写作助手，适用于中英文大学作业。触发词：学术写作、作业、报告、技术分析、研究综述、案例研究、项目文档。
dotfiles-guide
Use when adding new configurations, packages, or modules to this dotfiles repository. Covers file placement, package lists, and module creation.
innozverse-api-style
Follow API development conventions including RESTful design, Fastify patterns, Zod validation, error handling, and versioning. Use when building API endpoints, adding routes, or working with API code.
cs-guide-writer
CS 학습 문서를 작성합니다. "오늘의 CS", "CS 정리", "{주제} 정리해줘", "최근 이슈 CS" 요청 시 사용하세요.
button-styles
Sistema de estilos de botones consistentes para iqEngi (Cards, CTAs, Formularios)
backend-dev-guidelines
Opinionated backend development standards for Node.js + Express + TypeScript microservices. Covers layered architecture, BaseController pattern, dependency injection, Prisma repositories, Zod valid...
ashby-api-guide
This skill should be used when the user asks about "Ashby API", "how to use Ashby tools", "Ashby authentication", "Ashby MCP tools", "what can I do with Ashby", or needs help understanding available Ashby operations. Provides complete API documentation and tool usage guidance.
aiwf:backend-dev-guidelines
Comprehensive backend development guide for Node.js/Express/TypeScript microservices. Use when creating routes, controllers, services, repositories, middleware, or working with Express APIs, Prisma database access, Sentry error tracking, Zod validation, unifiedConfig, dependency injection, or async patterns. Covers layered architecture (routes → controllers → services → repositories), BaseController pattern, error handling, performance monitoring, testing strategies, and migration from legacy patterns.
migration-guides
Migration guides - from other AI tools, version upgrades, config migration. Use when switching from Cursor, Copilot, or Cody, upgrading Claude Code versions, or migrating configurations and customizations.
Claude Code Guide
Master guide for using Claude Code effectively. Includes configuration templates, prompting strategies "Thinking" keywords, debugging techniques, and best practices for interacting with the agent.