swift-api-design-guidelines

Name: swift-api-design-guidelines
Availability: InStock
Author: onymchat

Apply Swift API Design Guidelines to naming and documenting Swift APIs.

Updated Apr 30, 2026

Search Tags:#documentation #swift #naming #labels #protocols #api-design #mutating

Ready to run

npx skills add https://github.com/onymchat/onym-ios --skill swift-api-design-guidelines

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: swift-api-design-guidelines
Source: https://github.com/onymchat/onym-ios/tree/main/.claude/skills/swift-api-design-guidelines
Command: npx skills add https://github.com/onymchat/onym-ios --skill swift-api-design-guidelines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Crafting Swift APIs that are easy to read, consistent, and maintainable can be hard. This skill helps teams apply established guidelines to naming, labeling, and documenting Swift APIs to reduce ambiguity and improve call-site clarity.

Core Features & Use Cases

Guideline coverage: argument label rules, mutating/nonmutating naming, documentation structure, and protocol naming.
Use cases: reviewing new API design, refactoring existing APIs for clarity, and documenting public declarations for better discoverability.

Quick Start

Review a Swift module and adjust naming, labeling, and documentation to conform to the Swift API Design Guidelines.

Frequently Asked Questions about swift-api-design-guidelines

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I apply Swift API design guidelines for argument labels and protocol naming?▼

Swift API design guidelines recommend omitting argument labels when arguments are unlabeled at call site, using labels to clarify parameter roles, and naming protocols descriptively to improve call-site clarity and reduce ambiguity.

What is the best way to document Swift APIs for better discoverability and maintainability?▼

The best way to document Swift APIs is using structured documentation comments that explain functionality clearly at the call site. Following Swift API design guidelines for documentation improves public declaration discoverability and long-term maintainability.

When should I use mutating vs nonmutating naming in Swift API design?▼

Use mutating naming in Swift API design when a method modifies the receiver's state, and nonmutating naming when it returns a new value. This distinction enforces call-site clarity and aligns with established Swift API design guidelines.

How do I name Swift methods with -ed, -ing suffixes or form- prefixes according to API guidelines?▼

Name Swift methods using -ed or -ing suffixes for methods returning new values, and form- prefixes for methods creating new instances. This approach enforces best practices and improves clarity at the call site.

Does this Swift API design approach work for refactoring existing modules?▼

Yes, this Swift API design approach works for refactoring existing modules by adjusting naming, labeling, and documentation to conform to guidelines. It helps review new APIs and improve clarity across common Swift patterns.