トレーニング > オープンソースのベストプラクティス > オープンソース技術文書の要点 (LFC111)
トレーニングコース

Open Source Technical Documentation Essentials (LFC111)

オープンソースの開発者向けプロジェクトのドキュメント計画の作成と実行を開始します。

対象者

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

オープンソースのクラウドネイティブ製品のドキュメントにリソースを割くことの重要性を学びます。視聴者を特定し、既存のコンテンツを評価し、概念的な情報と詳細な情報のバランスをとり、効果的な API ドキュメントを定義し、高品質のコンテンツ制作を準備する方法を学びます。
少なく読む 続きを読む
身につく知識

このコースを終了すると、高品質のドキュメントを計画、作成、評価、強化し、オープンソース プロジェクトにシームレスに統合できるようになります。
少なく読む 続きを読む
おもなテーマ
第1章 イントロダクション
第2章 効果的な API ドキュメントの作成
第 3 章 API ドキュメントスイートの内容
第 4 章 文書化作業のサポート

前提条件
学生はソフトウェア エンジニアリングの概念と開発環境についての事前知識を持っている必要があります。さらに、API、そのユーザー、およびそのアプリケーションについての基本的な理解を推奨します。