June 11, 2021 CuttingEdgeTech 0Comment

The DocC documentation compiler, available in Xcode 13, converts Markdown-based text into rich documentation for Swift frameworks and packages and displays it right in the Xcode documentation window. DocC also powers the interactive developer tutorials featured on developer.apple.com. In this challenge, we invite you to explore the tutorial functionality and design and build step-by-step instructions for an existing project you’ve created or an open source Swift package.

Begin the challenge

To get started writing a tutorial, add a Documentation Catalog to your existing project, or create a new framework project.

You’ll write your tutorial content in Markdown, and use directives to define specific types of pages and elements, like introductions, sections, steps, and assessments. Then, use the Build Documentation feature of Xcode — which runs the DocC compiler — to render your tutorial in a rich, interactive learning format.

diagram showing markdown translated to DocC tutorial format

Want help with your tutorials in progress? On Friday from 1 p.m. – 4 p.m. PDT, you can visit the Digital Lounges: Drop by the Developer Tools Study Hall in the #devtools-study-hall channel to share your progress, ask questions about your project, and collaborate with others. You can also share your progress on the Developer Forums using the tag “WWDC21-Challenges,” or on social media using the hashtag #WWDC21Challenges.

Register for the Digital Lounges

Visit the Developer Tools Digital Lounge (Requires registration)

Explore WWDC21 Challenges on the Developer Forums

Explore #WWDC21Challenges on social media

Resources




  • WWDC21

Meet DocC documentation in Xcode

Create great documentation with DocC




  • WWDC21

Build interactive tutorials using DocC




  • WWDC21

Elevate your DocC documentation in Xcode

Learn more about DocC

Building an Interactive Tutorial

SlothCreator: Building DocC Documentation in Xcode

Read the WWDC21 Challenges Terms and Conditions

Powered by WPeMatico