---
title: "Discussion on \"Writing Good DocC Documentation for Swift Packages: Prose That Developers Actually Read\" | Hashnode"
description: "Discussion on \"Writing Good DocC Documentation for Swift Packages: Prose That Developers Actually Read\". DocC turns Swift documentation comments into a polished documentation site, and Xcode makes building it almost free. The hard part is not the tooling. It is the writing. Most Swift packages ship DocC"
url: "https://hashnode.com/posts/writing-good-docc-documentation-for-swift-packages-prose-that-developers-actually-read/6ade0b84ba9692b180a8fe14"
---

[Feed](https://hashnode.com/feed) /

Discussion

# [Writing Good DocC Documentation for Swift Packages: Prose That Developers Actually Read](https://auramacapps.hashnode.dev/writing-good-docc-documentation-for-swift-packages-prose-that-developers-actually-read?utm_source=hashnode&utm_medium=feed)

DocC turns Swift documentation comments into a polished documentation site, and Xcode makes building it almost free. The hard part is not the tooling. It is the writing. Most Swift packages ship DocC

Oct 25 · 5 min read · auramacapps.hashnode.dev  
Read the article

-   [#swift](https://hashnode.com/tag/swift)
-   [#documentation](https://hashnode.com/tag/documentation)
-   [#ios](https://hashnode.com/tag/ios)
-   [#macos](https://hashnode.com/tag/macos)

## Written by

[Aura Technologies](https://hashnode.com/@auramacapps)

@auramacapps

  
[View profile](https://hashnode.com/@auramacapps)

## Responses 1

Markdown supported · ⌘↵ to post

[Apps by Mo](https://hashnode.com/@appsbymo)

[Oct 25](https://hashnode.com/posts/writing-good-docc-documentation-for-swift-packages-prose-that-developers-actually-read/6ade0b84ba9692b180a8fe14/comment/6ade3274e47b2d570eb64f15)

Curated Topics groups are the part I keep relearning. An alphabetical symbol list only helps someone who already knows the name they want. One habit that has worked for me as a solo Mac developer: write the summary line in the same commit as the symbol, as you say, and let CI fail on broken symbol links. It keeps the docs from drifting between releases.
