Claude-skill-registry api-style-guide
Style and formatting rules for API/SDK documentation, samples, and tutorials.
install
source · Clone the upstream repo
git clone https://github.com/majiayu000/claude-skill-registry
Claude Code · Install into ~/.claude/skills/
T=$(mktemp -d) && git clone --depth=1 https://github.com/majiayu000/claude-skill-registry "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/data/api-style-guide" ~/.claude/skills/majiayu000-claude-skill-registry-api-style-guide && rm -rf "$T"
manifest:
skills/data/api-style-guide/SKILL.mdsafety · automated scan (low risk)
This is a pattern-based risk scan, not a security review. Our crawler flagged:
- makes HTTP requests (curl)
Always read a skill's source content before installing. Patterns alone don't mean the skill is malicious — but they warrant attention.
source content
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
- Language & Tone – audience-specific tone, terminology list, and banned phrases.
- Structure – endpoint/order conventions, table layouts, code block formatting, error doc patterns.
- Code Samples – naming standards, authentication handling, pagination patterns, inline comments.
- Metadata & Tags – version labels, availability notes, beta flags, locale indicators.
- 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
command to enforce consistent output.update-api-reference