swift-docc-documentation_skill
- Swift
11
GitHub Stars
13
Bundled Files
2 months ago
Catalog Refreshed
4 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill nonameplum/agent-skills --skill swift-docc-documentation- adding-code-snippets-to-your-content.md6.6 KB
- adding-images.md2.5 KB
- adding-structure-to-your-documentation-pages.md10.4 KB
- adding-supplemental-content-to-a-documentation-catalog.md7.3 KB
- adding-tables-of-data.md5.0 KB
- customizing-the-appearance-of-your-documentation-pages.md7.9 KB
- distributing-documentation-to-other-developers.md7.7 KB
- documenting-a-swift-framework-or-package.md5.8 KB
- formatting-your-documentation-content.md8.8 KB
- linking-to-symbols-and-other-content.md16.0 KB
- other-formatting-options.md2.3 KB
- SKILL.md4.0 KB
- writing-symbol-documentation-in-your-source-files.md8.7 KB
Overview
This skill is an authoritative reference for Swift DocC markup and syntax, packaged to help authors create rich API reference pages and interactive tutorials. It condenses the essentials of writing symbol documentation, adding supplemental articles, and formatting content for publication. Use it to learn best practices for linking symbols, embedding code snippets, and organizing documentation structure for Swift frameworks and packages.
How this skill works
The skill inspects DocC concepts and examples across core topics: symbol documentation, supplemental content, linking, snippets, formatting, and distribution. It explains how to annotate Swift source comments, add articles and extension files, structure pages into groups, and convert content into web-hostable documentation. Practical guidance covers API reference syntax, tutorial syntax, and multi-language representations when exposing APIs to other languages.
When to use it
- Creating or improving in-source Swift symbol documentation for a framework or package
- Building interactive tutorials that teach API usage step-by-step
- Adding supplemental articles or extension files to expand reference content
- Formatting pages with tables, images, and special elements for clarity
- Organizing symbols into groups and collections for easier navigation
Best practices
- Start with an introduction or getting-started article to orient readers
- Document public symbols in source comments and augment with extension files for examples
- Use explicit links between symbols and pages to improve discoverability
- Include runnable code snippets and language variants when applicable
- Structure pages into collections and groups to keep the catalog navigable
Example use cases
- Converting a Swift package's inline comments into a full API reference site
- Authoring an interactive tutorial that walks users through a common integration flow
- Adding conceptual articles that explain design patterns used by the framework
- Creating multi-language examples so the same API is documented for Swift and Objective-C callers
- Customizing documentation appearance and adding images or data tables for clarity
FAQ
No. DocC supports in-source symbol comments plus supplemental articles and extension files. Use source comments for reference and supplemental content for longer conceptual guides or tutorials.
Can I include runnable code snippets and multiple language variants?
Yes. The syntax supports embedding executable code snippets and providing language-specific representations for APIs callable from other languages.
