swift-api-design-guidelines-skill

SKILL.md

Swift API Design Guidelines Skill

Overview

Use this skill to design and review Swift APIs that are clear at the point of use, fluent in call sites, and aligned with established Swift naming and labeling conventions. Prioritize readability, explicit intent, and consistency across declarations, call sites, and documentation comments.

Work Decision Tree

1) Review existing code

Inspect declarations and call sites together, not declarations alone.

Check naming clarity and fluency (see references/promote-clear-usage.md, references/strive-for-fluent-usage.md).

Check argument labels and parameter naming (see references/parameters.md, references/argument-labels.md).

Check documentation comments and symbol markup (see references/fundamentals.md).

Check conventions and overload safety (see references/general-conventions.md, references/special-instructions.md).