特定のスキルを活用して製品固有の API ドキュメント要件を満たすと同時に、新規ユーザー向けの包括的なドキュメントを作成してエンゲージメントを促進します。
Creating Effective Documentation for Developers (LFC112)
対象者
このコースは、オープンソース開発者、プロジェクト マネージャー、エンジニアを対象に設計されており、さまざまなライティング スキルに対応します。基本的なプログラミング知識を持つテック ライターにとっても有益です。
折りたたむ
続きを読む
学習内容
さまざまなドキュメントの種類、API 要素、コードベースの参照の改善、技術的なコミュニケーション スキル、ソフトウェア開発におけるドキュメントの計画、技術ドキュメントを強化するためのライターや編集者とのコラボレーションなど、効果的な API ドキュメントの基本を学びます。
折りたたむ
続きを読む
身につく知識
このコースでは、製品ドキュメントを作成、強化、評価するための準備をします。高品質のドキュメントを計画し、情報を効果的に伝え、対象分野の専門家としてライターと協力して、技術的な知識をユーザーに効率的に伝えることができます。
折りたたむ
続きを読む
前提条件
2024年9月
このコースの最も優れた点は、プロジェクトに携わる全員が団結したチームとして協力することの重要性を強調したことです。このコースでは、効果的なドキュメント作成は 1 人の責任だけではなく、チーム メンバーが互いのニーズをサポートする共同作業であることが強調されました。明確でアクセスしやすいドキュメントの価値を理解することで、開発者、テスター、その他の関係者が常に足並みを揃え、コミュニケーションを改善し、最終的にプロジェクトの成功を促進できます。
2024年7月
このコースでは、テクニカルライターの仕事についてより深く理解でき、自分の仕事にも応用できそうなワークフローも学ぶことができました。
2024年6月
ドキュメント生成リソース、開発者/ライターのワークフローと知識共有の明確な説明が気に入りました。
2024年6月
このコースでは、ライターとエンジニアリング チーム間のコラボレーションの概要をわかりやすく説明します。また、適切に構造化された方法で作業を完了するための優れたヒントも提供します。
2024年4月
このコースは私や私のチームにとって素晴らしい参考資料になりそうです!
2024 年 3 月
このコースは短く、簡潔で、よく書かれており、理解しやすいものでした。
2024 年 2 月
このコースでは、チームが専門のライターと協力する必要があること、見つかる API の種類、ツールがドキュメント生成をサポートするが、それらの情報は後で入力する必要があることが説明されている点が気に入っています。
2024 年 2 月
ドキュメント作成に関する実践的な知識を学びました。
2024 年 2 月
トレーニングはユーザーフレンドリーで使いやすかったです。
2024 年 2 月
実行する必要があることの実用的な例と、技術文書の作成に役立つ非常に有益なツールのリスト。とても気に入りました!
2024 年 1 月
時々、基本に戻って再評価する必要があります。素晴らしい取り組みです。
2024 年 1 月
私は、この技術に利用できるツール、SME と連携する手順、他のチームからのフィードバックとレビューの取得、そして最適なドキュメント作成のために継続的にレビューと更新を行うことについて学ぶのが好きでした。
2024 年 1 月
ドキュメント作成に関する興味深い情報が満載です。