swift-api-design-guidelines

Enforce Swift API Design Guidelines for naming and argument labels.

Updated Jun 5, 2026
One-click install
npx skills add https://github.com/harshav167/build-ios-apps --skill swift-api-design-guidelines-harshav167
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swift-api-design-guidelines
Source: https://github.com/harshav167/build-ios-apps/tree/main/skills/swift-api-design-guidelines
Command: npx skills add https://github.com/harshav167/build-ios-apps --skill swift-api-design-guidelines-harshav167

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Swift API designs often suffer from ambiguous argument labels and inconsistent naming that obscure call-site readability.

Core Features & Use Cases

  • Enforces grammatical phrase rules and prepositional label usage for fluent call sites.
  • Guides mutating vs nonmutating naming with -ed/-ing forms or form-prefix patterns for clarity.
  • Standardizes documentation comments, protocol naming, and default arguments to improve API consistency.

Quick Start

Apply these guidelines when designing or auditing a Swift API surface to improve readability and consistency.

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 design Swift API naming for clear call-site readability?

Swift API naming uses grammatical phrasing and prepositional argument labels to create fluent, unambiguous call sites. It enforces consistent naming conventions across methods to ensure they read naturally at the point of use.

When should I use mutating vs nonmutating method names in Swift?

Use mutating vs nonmutating naming in Swift by applying -ed/-ing forms or form-prefix patterns for clarity. This distinction clarifies whether a method modifies state in place or returns a new value.

What's the best way to standardize Swift protocol naming and documentation comments?

Standardize Swift protocol naming and documentation comments by applying consistent casing, grammatical rules, and default arguments. This improves API consistency and makes interfaces easier to understand.

How do I use prepositional argument labels in Swift API design?

Prepositional argument labels in Swift API design guide fluent call sites by clarifying the relationship between parameters. They enforce grammatical phrasing to make method signatures read naturally.

Why does my Swift API design have ambiguous argument labels?

Swift API design suffers from ambiguous argument labels when naming is inconsistent or grammatical phrasing is ignored. Applying rules for prepositional labels and default arguments resolves call-site readability issues.

When do I need to use make-prefixed factories and form prefixes in Swift?

Use make-prefixed factories and form prefixes in Swift to align with API design guidelines for clear naming. They distinguish factory methods and type-conversion methods from mutating pairs, improving readability.