author-swift-docc-docs

Author and review DocC content for Swift package and Xcode repositories.

9|1|Updated Feb 27, 2026
One-click install
npx skills add https://github.com/gaelic-ghost/apple-dev-skills --skill author-swift-docc-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: author-swift-docc-docs
Source: https://github.com/gaelic-ghost/apple-dev-skills/tree/main/skills/author-swift-docc-docs
Command: npx skills add https://github.com/gaelic-ghost/apple-dev-skills --skill author-swift-docc-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Provide a focused, repo-aware workflow for writing and reviewing DocC documentation so authors can produce structurally correct symbol comments, articles, extension files, landing pages, and topic groups without accidentally drifting into unrelated Apple docs lookup or build/export work.

Core Features & Use Cases

  • Repo-shape classification: Detect whether a repository is a Swift package or an Xcode app/framework and surface detected manifests, workspaces, and .docc catalogs.
  • Task inference and gating: Classify requests into symbol-docs, article, structure, review, or tutorial-aware-review and enforce tutorial-depth boundaries via configurable knobs.
  • Handoffs and contracts: Produce a clear JSON contract that either keeps work local to DocC authoring/review or hands off to explore-apple-swift-docs, swift-package-build-run-workflow, or xcode-build-run-workflow for lookup or execution tasks.
  • Customizable behavior: Respect per-skill customization for tutorial handling and persist durable settings in a user config location.

Quick Start

Ask the skill to inspect your repository and infer the DocC task by running the workflow with your repo path and an optional task description.

Frequently Asked Questions about author-swift-docc-docs

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

FAQPage Schema
How do I write DocC documentation for a Swift package repository?

To write DocC documentation for a Swift package, you need to author structurally correct symbol comments, articles, extension files, and topic groups. A focused workflow can detect your repo shape and infer the specific documentation task to keep your authoring aligned.

What's the best way to review DocC content in an Xcode project?

Reviewing DocC content in an Xcode project involves checking symbol docs, landing pages, and tutorial depth boundaries. A task-inference workflow classifies the review request and applies configurable knobs to ensure the documentation meets structural requirements without drifting into unrelated build tasks.

Can I author Swift tutorials and control their depth using DocC?

Yes, you can author Swift tutorials and control their depth using DocC by applying configurable tutorial-depth boundaries. The workflow gates tutorial-aware reviews and enforces depth limits through customizable settings persisted in a user config location.

Does this DocC authoring workflow support handing off to Apple docs lookup?

Yes, the DocC authoring workflow supports handing off to Apple docs lookup by producing a clear JSON contract. When a request exceeds local authoring or review scope, it triggers a handoff to broader Apple documentation exploration or build and export execution workflows.

How do I structure DocC articles and topic groups for my Swift code?

Structuring DocC articles and topic groups requires organizing your Swift code documentation into a coherent hierarchy. The workflow classifies your request as a structure task and helps you produce correct extension files and landing pages tailored to your detected repository shape.

When should I hand off DocC authoring to a Swift package build workflow?

You should hand off DocC authoring to a Swift package build workflow when your task requires actual execution or export rather than content creation. The workflow generates a JSON contract that explicitly routes build and lookup tasks away from local DocC authoring.