DocCドキュメントのビデオとタブ

DocCの基本的なMarkdownを超えて

ほとんどの開発者はDocCが標準的なMarkdownをサポートしていることを知っていますが、驚くほど活用されていない2つの強力なディレクティブがあります：ビデオの埋め込みとタブ付きコンテンツです。どちらもXcodeのドキュメントビューアとホストされたDocCウェブサイトで動作します。

ビデオの埋め込み

ドキュメントにビデオを追加するには1つのディレクティブだけです：

@Video(source: "setup-walkthrough.mp4")

ビデオファイルをドキュメントカタログのResourcesフォルダに配置します。これにより、ドキュメント内にインラインのビデオプレーヤーが直接レンダリングされます。外部URLへのリンクやビジュアルプロセスをテキストで説明するよりもはるかに効果的です。セットアップガイド、UIのウォークスルー、アニメーションのデモに最適です。

TabNavigatorによるタブ付きコンテンツ

代替アプローチやプラットフォーム固有の手順を表示する必要がある場合、タブを使うと読者を圧倒せずに情報を整理できます：

@TabNavigator {
   @Tab("SwiftUI") {
      Use the `.environment` modifier to inject dependencies.
   }
   @Tab("UIKit") {
      Override `viewDidLoad` and configure your dependencies there.
   }
}

これは読者がセクション間を切り替えられる適切なタブインターフェースとしてレンダリングされます。複数のプラットフォーム、APIバージョン、設定アプローチをカバーするドキュメントに特に便利です。

実践的なアドバイス

これらの機能を使ってContributingガイドを更新したところ、テキストの壁よりも明らかにアプローチしやすい結果になりました。ビデオは段落で説明するのに必要なセットアッププロセスを示し、タブはプラットフォーム固有の手順をきれいに分離します。

これらのディレクティブはAppleのDocCドキュメントに記載されていますが、チュートリアルで言及されることはほとんどありません。オープンソースのSwiftパッケージをメンテナンスしている方は、ドキュメントカタログにこれらを追加することを検討してください。人々がドキュメントを体験する方法に本当に違いが出ます。