{
  "markdown": "# Swift API Design Guidelines Skill\n\nExpert guidance for any AI coding tool that supports the [Agent Skills open format](https://agentskills.io/home) - focused on Swift API naming, argument labels, terminology, documentation comments, and conventions.\n\nThis repository distills the Swift API Design Guidelines into actionable, concise references for agents and code review workflows.\n\n## Who this is for\n- Teams designing or reviewing Swift APIs and SDK surfaces\n- Developers refactoring existing APIs for clarity at the point of use\n- Anyone who wants APIs that read fluently and reduce ambiguity in call sites\n\n## How to Use This Skill\n\n### Option A: Using skills.sh (recommended)\nInstall this skill with a single command:\n\n```bash\nnpx skills add https://github.com/Erikote04/Swift-API-Design-Guidelines-Agent-Skill --skill swift-api-design-guidelines-skill\n```\n\nThen use the skill in your AI agent, for example:\n> Use the swift-api-design-guidelines skill and review this code for naming, argument labels, and API clarity.\n\n### Option B: Claude Code Plugin\n\n#### Personal Usage\nTo install this skill for your personal use in Claude Code:\n\n1. Add the marketplace:\n\n```bash\n/plugin marketplace add Erikote04/Swift-API-Design-Guidelines-Agent-Skill\n```\n\n2. Install the skill:\n\n```bash\n/plugin install swift-api-design-guidelines@swift-api-design-guidelines-skill\n```\n\n#### Project Configuration\nTo automatically provide this skill to everyone working in a repository, configure `.claude/settings.json`:\n\n```json\n{\n  \"enabledPlugins\": {\n    \"swift-api-design-guidelines@swift-api-design-guidelines-skill\": true\n  },\n  \"extraKnownMarketplaces\": {\n    \"swift-api-design-guidelines-skill\": {\n      \"source\": {\n        \"source\": \"github\",\n        \"repo\": \"Erikote04/Swift-API-Design-Guidelines-Agent-Skill\"\n      }\n    }\n  }\n}\n```\n\nWhen team members open the project, Claude Code will prompt them to install the skill.\n\n### Option C: Manual install\n1. Clone this repository.\n2. Install or symlink the `swift-api-design-guidelines-skill/` folder following your tool's official skills installation docs.\n3. Use your AI tool as usual and ask it to use the `swift-api-design-guidelines` skill for API design tasks.\n\n#### Where to Save Skills\nFollow your tool's official documentation:\n- Codex: [Where to save skills](https://developers.openai.com/codex/skills/#where-to-save-skills)\n- Claude: [Using Skills](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview#using-skills)\n- Cursor: [Enabling Skills](https://cursor.com/docs/context/skills#enabling-skills)\n\nHow to verify:\n- Your agent should reference workflows/checklists in `swift-api-design-guidelines-skill/SKILL.md`\n- It should then load the relevant file from `swift-api-design-guidelines-skill/references/` for topic-specific guidance\n\n## What This Skill Offers\n\nThis skill gives your AI coding tool practical guidance for Swift API design. It can:\n\n### Guide API Design Decisions\n- Improve naming clarity at the point of use\n- Apply argument-label rules based on grammar and meaning\n- Enforce consistent mutating/nonmutating naming pairs\n- Improve terminology use and reduce ambiguity\n\n### Improve API Documentation\n- Produce concise, useful declaration summaries\n- Apply recognized symbol markup (`Parameter`, `Returns`, `Throws`, `Note`, etc.)\n- Encourage documentation that matches actual API semantics\n\n### Strengthen API Review Quality\n- Catch overloaded APIs that become ambiguous with weak typing\n- Flag redundant type words and role-unclear identifiers\n- Encourage defaults and parameter ordering that improve readability\n\n## What Makes This Skill Different\n\nNon-opinionated: Focuses on API correctness and clarity, not architecture or folder structures.\n\nGuidelines-first: Anchored in Swift API Design Guidelines semantics and established conventions.\n\nPractical and concise: Optimizes for real review and implementation workflows, not theoretical style debates.\n\n## Skill Structure\n<!-- BEGIN REFERENCE STRUCTURE -->\n```text\nswift-api-design-guidelines-skill/\n  SKILL.md\n  references/\n    argument-labels.md - Rules for first-argument labels, grammar, and conversion cases\n    fundamentals.md - Core priorities and documentation-comment principles\n    general-conventions.md - Complexity docs, casing, free-function exceptions, overload conventions\n    parameters.md - Parameter naming, defaults, ordering, and file literal guidance\n    promote-clear-usage.md - Naming clarity, omitted words, and role-based identifiers\n    special-instructions.md - Tuple/closure naming and weak-type overload disambiguation\n    strive-for-fluent-usage.md - Fluent call-site phrasing and mutating/nonmutating naming pairs\n    use-terminology-well.md - Terms of art, abbreviations, and precedent\n```\n<!-- END REFERENCE STRUCTURE -->\n\n## Contributing\n\nContributions are welcome! This repository follows the [Agent Skills open format](https://agentskills.io/home), which has specific structural requirements.\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for:\n- How to contribute improvements to `SKILL.md` and the reference files\n- Format requirements and quality standards\n- Pull request process\n\n## About the author\n\nCreated by [Erik Sebastian de Erice Jerez](https://github.com/Erikote04).\n\n## License\n\nThis skill is open-source under the MIT License. See [LICENSE](LICENSE) for details.\n",
  "bytes": 5359,
  "sha": "028d3820f4f52c83d5f23f82f3b437b77e851f1c66bd5bba12a228e3fe7bc386",
  "repo_slug": "erikote04/swift-api-design-guidelines-agent-skill",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/skl_erikote04_swift_api_design_guidelines_ag_14b683a7/readme"
}