優れたドキュメントは導入と参加を促進します
Linux Foundation Training & Certification は、オープンソース開発者、プロジェクト マネージャー、エンジニアのドキュメント スキルの向上を支援する 2 つの新しい無料コースを開始しました。強力なオープンソース ドキュメントにより、プロジェクトがよりアクセスしやすくなり、導入が促進され、コミュニティへの参加が促進されます。
CNCF の CTO、Chris Aniszczyk 氏は次のように述べています。 「これらのコースによって世界中のオープンソース技術文書のスキルが向上し、今後もオープンソース プロジェクトをより貢献しやすいものにしていくことができることを願っています。」
「ドキュメントはオープンソース プロジェクトの成功の鍵ですが、時間を割く IT プロフェッショナルが少なすぎます」と Linux Foundation のトレーニングおよび認定担当ゼネラル マネージャー、SVP の Clyde Seepersad 氏は述べています。 「これらのコースは、特に IT プロフェッショナルが自信を持ち、消費者や貢献者と関わる確実なプロジェクト ドキュメントを作成する簡単な方法を見つけるのに役立つように設計されています。」
オープンソース技術文書の要点 (LFC111) は、コミュニティの参加を促進するには、優れたドキュメントの重要性を強調しています。このコースでは次のことを教えます。
- 卓越した技術コミュニケーション:
- 導入を加速する
- サポートコストの削減
- 顧客満足度と顧客維持率の向上
- エンジニアリング効率の向上
- 活気に満ちたオープンソース コミュニティの成長を促進する
- ユーザーがソフトウェアと API を適切に使用できるようにするために、どのように効果的なドキュメントを作成するか
- どのような種類のドキュメントが興味を引き、ユーザーがすぐに理解できるようになりますか
- 既存のドキュメントの有効性を評価する方法
- ドキュメントを改善する方法
開発者向けの効果的なドキュメントの作成 (LFC112) は、API を備えた製品に重点を置き、効果的なドキュメントを作成することに重点を置いています。参加者は以下を学びます:
- API リファレンスと他のタイプのドキュメントの違い
- API リファレンスに含まれるコンテンツ
- ソースコードと仕様からドキュメントを自動生成する方法
- 生成されたドキュメントの有効性を向上させる方法
- ソフトウェア エンジニアとプロのライター/編集者がコラボレーションする方法
各コースは 3 ～ 4 時間のコンテンツで構成されています。各コースを無事に完了した人には、デジタル バッジと完了証明書が与えられます。
