{"id":127905,"date":"2021-06-11T05:00:30","date_gmt":"2021-06-11T05:00:30","guid":{"rendered":"https:\/\/developer.apple.com\/news\/?id=ta87bwxi"},"modified":"2021-06-11T05:00:30","modified_gmt":"2021-06-11T05:00:30","slug":"challenge-create-an-engaging-tutorial","status":"publish","type":"post","link":"https:\/\/sickgaming.net\/blog\/2021\/06\/11\/challenge-create-an-engaging-tutorial\/","title":{"rendered":"Challenge: Create an engaging tutorial"},"content":{"rendered":"
<\/div>\n

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\u2019ve created or an open source Swift package.<\/p>\n

Begin the challenge<\/h3>\n

To get started writing a tutorial, add a Documentation Catalog to your existing project, or create a new framework project. <\/p>\n

You\u2019ll 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 \u2014 which runs the DocC compiler \u2014 to render your tutorial in a rich, interactive learning format.<\/p>\n

\"diagram<\/div>\n

Resources<\/h3>\n
\n
\n
<\/a> <\/section>\n
<\/p>\n

Meet DocC documentation in Xcode<\/h4>\n

Discover how you can use DocC to build and share documentation for Swift packages and frameworks. We\u2019ll show you how to begin generating documentation from your own code \u2014 or from third-party code you depend upon \u2014 and write and format it using Markdown. And we\u2019ll also take you through the…<\/p>\n

<\/a> <\/section>\n<\/section>\n<\/section>\n

Create great documentation with DocC<\/a><\/p>\n

\n
\n
<\/a> <\/section>\n
<\/p>\n

Build interactive tutorials using DocC<\/h4>\n

Discover how you can author immersive tutorials from scratch with DocC. We\u2019ll demonstrate how you can bring together rich instructions, example code, and images through the DocC syntax to showcase your Swift framework in action. And we\u2019ll go over how to create progressive training that can…<\/p>\n

<\/a> <\/section>\n<\/section>\n<\/section>\n

\n
\n
<\/a> <\/section>\n
<\/p>\n

Elevate your DocC documentation in Xcode<\/h4>\n

Great documentation can help people effectively and easily adopt your Swift framework. Discover how you can create rich, conceptual articles to accompany your API. You\u2019ll learn best practices for writing articles, including how to structure your documentation, and find out how to create…<\/p>\n

<\/a> <\/section>\n<\/section>\n<\/section>\n

Visit the Apple Developer Forums<\/a><\/p>\n

Building an Interactive Tutorial<\/a><\/p>\n

SlothCreator: Building DocC Documentation in Xcode<\/a><\/p>\n

Read the WWDC21 Challenges Terms and Conditions<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

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 […]<\/p>\n","protected":false},"author":2,"featured_media":127906,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[55],"tags":[],"class_list":["post-127905","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-apple-developer-news"],"_links":{"self":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/127905","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/comments?post=127905"}],"version-history":[{"count":0,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/127905\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media\/127906"}],"wp:attachment":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media?parent=127905"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/categories?post=127905"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/tags?post=127905"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}