swift-api-design-guidelines-skill

Align Swift API naming, argument labels, and documentation with design guidelines.

Updated May 6, 2026

Search Tags:#code review #refactoring #api design #swift #naming conventions #argument labels #documentation comments

Ready to run

npx skills add https://github.com/Roy-wonji/claude-config --skill swift-api-design-guidelines-skill-roy-wonji

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: swift-api-design-guidelines-skill
Source: https://github.com/Roy-wonji/claude-config/tree/main/skills/swift-api-design-guidelines
Command: npx skills add https://github.com/Roy-wonji/claude-config --skill swift-api-design-guidelines-skill-roy-wonji

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It solves the problem of confusing or unclear Swift API surfaces by helping you choose names, argument labels, and documentation that read naturally at the point of use.

Core Features & Use Cases

API clarity review: Assess declarations and call sites together to spot ambiguity in naming, parameter roles, and overload readability.
Improvement guidance: Refactor existing APIs by renaming, reworking argument labels, clarifying summaries, and strengthening documentation to match behavior precisely.
New API design from examples: Start from use-site examples to ensure fluent English-like call patterns, correct mutating/nonmutating naming pairs, and consistent symbol markup.

Quick Start

Ask the AI to review a Swift API for clarity and fluency using Swift API Design Guidelines, including naming, argument labels, and documentation summaries, and return concrete rename and label suggestions.

Frequently Asked Questions about swift-api-design-guidelines-skill

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

FAQPage Schema

How do I design a Swift API with clear argument labels and naming conventions?▼

Review Swift API call sites to spot ambiguity in naming, parameter roles, and overload readability. This process assesses declarations and call sites together to identify confusing or unclear Swift API surfaces and improve overall clarity.

How do I refactor existing Swift interfaces to improve call-site fluency?▼

Refactor existing Swift interfaces by renaming declarations, reworking argument labels, and clarifying summaries. This strengthens documentation to match behavior precisely and ensures the API reads naturally at the point of use.

When do I need to add documentation comments and symbol markup to Swift declarations?▼

Add documentation comments and symbol markup to Swift declarations when designing new APIs or refactoring existing ones. Every public declaration requires an accurate documentation summary to resolve ambiguity in parameters and weakly typed overloads.

What is the best way to resolve ambiguity in Swift API parameters and weakly typed overloads?▼

Resolve ambiguity in Swift API parameters and weakly typed overloads by starting from use-site examples. This ensures fluent English-like call patterns and correct mutating/nonmutating naming pairs across declarations and overload sets.

Can I use Swift API Design Guidelines for reviewing call-site fluency across overload sets?▼

Yes, you can use Swift API Design Guidelines for reviewing call-site fluency across declarations and overload sets. It helps identify ambiguity in parameter roles and ensures consistent symbol markup throughout the interface.