Swift DocC × GitHub Pages で作る “使える” SDK ドキュメント構築術 by ohayoukenchan

開発者にとって、使いやすいSDKドキュメントはプロジェクトの成功に不可欠です。にもかかわらず、ドキュメントの整備や運用には多くのハードルがあり、「後回しになりがち」「仕様と乖離しやすい」「更新が面倒」といった課題を抱える現場も多いのではないでしょうか。

本セッションでは、Xcode に標準搭載されている DocC と GitHub Pages を活用し、開発コストを抑えつつ、ユーザーにとって“使える”ドキュメントを自動生成・公開する方法を、実例とともに丁寧に解説します。

以下のような構成で、ドキュメント構築の一連の流れを紹介します：

• /// コメントから始める DocC ドキュメンテーションの基本
• xcodebuild docbuild による .doccarchive 生成とその仕組み
• xcrun docc process-archive transform-for-static-hosting を使った静的ホスティング対応
• GitHub Actions を用いた CI/CD 自動化による公開フローの構築
• Parameters・Returns・Note・Important などを活かしたリッチな Markdown 記法
• ユーザー視点で見やすく、保守しやすい構造設計のポイント

これらは、実際に私たちが開発・提供している SDK に DocC を導入し、社内外に向けたドキュメント公開を運用した経験に基づいています。導入時にハマった落とし穴や、記述の最適化ポイントもあわせて共有します。

自社SDKやライブラリをより使いやすく、メンテナンスしやすいものにしたい開発者に向けた、実践的なDocC活用術です。