Swift Digest
この記事の要点
- Swift のドキュメント体験を改善するための新しいワークグループ「Documentation Workgroup」の発足が発表されました。Swift-DocC をはじめとするドキュメント関連ツールの開発を導き、ドキュメントへのコントリビューションを統制するプロセスを定めることを目的としています。
- 当初の目標は、エコシステム全体に役立つようドキュメントツールの開発を方向付けることと、ドキュメントツールへのコントリビューションを規定するプロセスを定義することの 2 点です。将来的には、優れたドキュメントを書くためのガイドラインづくりや、Swift 言語自体のドキュメント体験への関与にも取り組むとされています。
- ワークグループは Swift Mentorship Program の積極的なメンバーとして参加し、技術的なコントリビューションへの参加障壁を下げることにも取り組みます。Diversity in Swift チームとも連携し、コミュニティ全体の視点を反映させます。
何が変わるのか
Documentation Workgroup の発足
新設される Documentation Workgroup は、Swift 言語とエコシステムに優れたドキュメント体験をもたらすことを目指します。当初の目標として、次の 2 点が掲げられています。
- Swift-DocC のようなドキュメントツールの開発を、エコシステム全体の利益になるよう方向付けること
- ドキュメントツールへのコントリビューションを規定するプロセスを定義すること
ワークグループは、Swift 全体で一貫したドキュメント体験を実現するために活動します。時間をかけて、優れたドキュメントを書くためのガイドラインの策定を支援し、Swift 言語自体のドキュメント体験にも関与していくとされています。
参加障壁を下げる取り組み
ワークグループは、開発者が Swift のドキュメント体験に参加できるよう積極的に手助けし、プロジェクトへの技術的なコントリビューションの障壁を下げることを目標としています。そのために、ワークグループは Swift Mentorship Program の積極的なメンバーとして参加し、コミュニティのメンバーに直接的なガイダンスを提供します。また、ほかの Swift ワークグループと同様に、Diversity in Swift チームと連携し、Swift コミュニティ全体の理念と関心が常に考慮されるようにします。
背景
ドキュメントはコードを書く上で欠かせない要素であり、優れたドキュメントを作成するためのリソースを充実させることへの期待がコミュニティの中で高まっていました。2021 年には Swift-DocC がオープンソース化され、ドキュメントツールの開発がコミュニティに開かれていました。こうした流れを受け、ドキュメント関連ツールの開発の方向付けやコントリビューションのプロセスづくりを担う場として、Documentation Workgroup が設けられました。
参加・利用者への影響
この記事は、Swift のドキュメントやドキュメントツールに関心があるすべての人に向けたものです。Documentation Workgroup に関わる方法として、記事では次の導線が案内されています。
- Documentation Workgroup のチャーター（charter）を読む
- Swift-DocC フォーラムでアイデアを議論する
- @swift-documentation-workgroup ハンドルを使ってフォーラムでワークグループに直接連絡する