swift-api-design-guidelines-skill

Designing Swift APIs for clarity involves aligning naming, argument labels, and documentation comments with established Swift conventions. You analyze interfaces from a use-site perspective to ensure fluent, readable call sites.

Refactoring ambiguous Swift interfaces requires reviewing naming clarity, argument labeling, and terminology. You improve readability by balancing mutating versus nonmutating naming and grammar to achieve fluent call sites.

Writing fluent Swift argument labels requires evaluating methods from the use-site perspective. You maintain consistency in label usage and align with Swift conventions to ensure the API reads naturally when invoked.

Yes, you can review Swift documentation comments for API consistency. The process enforces per-declaration documentation requirements and checks terminology alignment to maintain clarity across small libraries and large frameworks.

You need to align mutating versus nonmutating naming in Swift whenever you refactor or create interfaces. Maintaining consistent naming conventions ensures API behavior is clear and predictable at the point of use.

Yes, this approach supports API design reviews for large Swift frameworks. It guides the design of new APIs and the refactoring of existing ones to improve fluency and maintainability across entire project roadmaps.