トレーニング > オープンソースのベストプラクティス > 開発者向けの効果的なドキュメントの作成 (LFC112)
トレーニングコース

Creating Effective Documentation for Developers (LFC112)

特定のスキルを活用して製品固有の API ドキュメント要件を満たすと同時に、新規ユーザー向けの包括的なドキュメントを作成してエンゲージメントを促進します。

対象者

このコースは、オープンソース開発者、プロジェクト マネージャー、エンジニアを対象に設計されており、さまざまなライティング スキルに対応します。基本的なプログラミング知識を持つテック ライターにとっても有益です。
少なく読む 続きを読む
学習内容

さまざまなドキュメントの種類、API 要素、コードベースの参照の改善、技術的なコミュニケーション スキル、ソフトウェア開発におけるドキュメントの計画、技術ドキュメントを強化するためのライターや編集者とのコラボレーションなど、効果的な API ドキュメントの基本を学びます。
少なく読む 続きを読む
身につく知識

このコースでは、製品ドキュメントを作成、強化、評価するための準備をします。高品質のドキュメントを計画し、情報を効果的に伝え、対象分野の専門家としてライターと協力して、技術的な知識をユーザーに効率的に伝えることができます。
少なく読む 続きを読む
おもなテーマ
第1章 イントロダクション
第2章 効果的な API ドキュメントの作成
第 3 章 API ドキュメントスイートの内容
第 4 章 文書化作業のサポート

前提条件
学生は、このトピックで議論されているトピックに精通している必要があります。 オープンソース技術文書の要点 (LFC111) コース。また、ソフトウェア エンジニアリングの概念と開発環境についての事前知識も必要です。さらに、API、そのユーザー、およびそのアプリケーションについての基本的な理解を推奨します。