swift-docc

Generate DocC-based API documentation for Swift frameworks and packages.

16|2|Updated Jan 1, 2026
One-click install
npx skills add https://github.com/nonameplum/agent-skills --skill swift-docc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swift-docc
Source: https://github.com/nonameplum/agent-skills/tree/main/swift-docc-documentation
Command: npx skills add https://github.com/nonameplum/agent-skills --skill swift-docc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides a structured reference for DocC markup and syntax, enabling users to learn and apply DocC directives, metadata, and documentation layouts to Swift frameworks and packages.

DocC users gain a clear guide to organize references, tutorials, and articles, ensuring consistent documentation practices across projects.

Core Features & Use Cases

  • Comprehensive reference: explains how to compose Symbol links, Metadata, DocumentationExtension, and page customization.
  • Documentation catalog guidance: covers structuring Articles, Tutorials, and Resources with consistent navigation.
  • Real-world use cases: demonstrates documenting a Swift framework with examples of symbol references and tutorial content.

Quick Start

Review the included DocC references to begin a minimal catalog: create a .docc directory adjacent to your target, add a SKILL.md with the proper name and description, and populate pages using DocC directives. Then use Swift DocC tooling to preview or publish the documentation.

Frequently Asked Questions about swift-docc

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

FAQPage Schema
How do I generate DocC documentation for a Swift framework?

To generate DocC documentation, create a .docc directory adjacent to your Swift target, add a SKILL.md defining name and description, populate pages using DocC directives, and preview or publish with Swift DocC tooling.

What is the best way to structure a Swift DocC documentation catalog?

Structure a DocC documentation catalog by organizing Articles, Tutorials, and Resources with consistent navigation, applying standard Markdown metadata and DocC directives for page customization and clear symbol linking.

How do symbol links and metadata work in Swift DocC markup?

Symbol links and metadata in Swift DocC markup connect API references and customize documentation pages, using specific directives to compose DocumentationExtension content and ensure consistent documentation practices across Swift frameworks.

Do I need standard Markdown to write DocC tutorials and articles?

Yes, standard Markdown is required for writing DocC tutorials and articles, combined with DocC directives and frontmatter metadata that defines the name and description to structure tutorial content and references.

Can I use DocC for documenting Swift packages needing extension content?

Yes, DocC applies to Swift packages needing structured symbol linking and extension content, providing a reference to compose DocumentationExtension files and organize catalogs with consistent navigation.