Individual skill

api-style-guide

0upvotes

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

plugins/technical-writing/skills/api-style-guide/SKILL.md

Read pinned source

Source commit 78e0419f4440bcb43bc80127e174ecf5adef1753

What was checked

Matches the observed repository HEAD: Yes
Scanner rules are current: Yes
Repository scan complete: No
Skill scan complete: Yes
Observed behavior: Network or broad shell
Last checked: Nov 10, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings): 438
Repository last updated: Apr 3, 2026
License: Apache-2.0

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

docs Derived category

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files

SKILL.mdcore · 1,361 bytes

Read excerpt


# 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.