第1章 イントロダクション
オープンソースの開発者向けプロジェクトのドキュメント計画の作成と実行を開始します。
トレーニングコース
Open Source Technical Documentation Essentials (LFC111)
対象者
このコースは、オープンソース開発者、プロジェクト マネージャー、エンジニアを対象に設計されており、さまざまなライティング スキルに対応します。基本的なプログラミング知識を持つテック ライターにとっても有益です。
折りたたむ
続きを読む
学習内容
オープンソースのクラウドネイティブ製品のドキュメントにリソースを割くことの重要性を学びます。視聴者を特定し、既存のコンテンツを評価し、概念的な情報と詳細な情報のバランスをとり、効果的な API ドキュメントを定義し、高品質のコンテンツ制作を準備する方法を学びます。
折りたたむ
続きを読む
身につく知識
このコースを終了すると、高品質のドキュメントを計画、作成、評価、強化し、オープンソース プロジェクトにシームレスに統合できるようになります。
折りたたむ
続きを読む
第1章 イントロダクション
第2章 効果的な API ドキュメントの作成
第 3 章 API ドキュメントスイートの内容
第 4 章 文書化作業のサポート
前提条件
2024年9月
このコースでは、ユーザーとチームの両方にとってドキュメントが非常に詳細であることがいかに重要であるかを強調していたのが気に入りました。
2024年8月
このコースの最も優れた点は、オープンソースの技術ドキュメントに対する包括的なアプローチでした。わかりやすい説明と実用的な例が役立ち、ドキュメント作成におけるベストプラクティスとよくある落とし穴を理解することができました。インタラクティブな要素と実際のケーススタディにより、学習体験が魅力的になり、実際のプロジェクトに適用できるようになりました。
2024年7月
これは、オープンソース プロジェクトを効果的に文書化するための重要な側面を網羅した、短くて集中的なコースです。
2024年6月
このコースでは、ドキュメントの概念について学びました。以前からいくつかのアイデアはありましたが、これほど強烈なものではありませんでした。
2024年5月
このコースでは、技術文書で取り上げられている内容をかなり網羅的にリストアップし、従うべき主なポイントを概説してくれたので、本当にありがたかったです。これにより、最終的には、これらのテーマについて他のプロジェクトで行われたことからインスピレーションを得て、これらのトピックをさらに深く掘り下げることができるようになります。
2024年4月
このコースには、繰り返し参照できる「クイック評価チェックリスト」などの簡単に習得できる内容が含まれています。
2024年4月
サービスとしてのドキュメンテーションがかなり本格的なビジネスになっているとは知りませんでした。このコースは私の期待に応えてくれました。LFC112 が今から楽しみです。
2024 年 3 月
読みやすく、理解しやすいです。さらに、このコースでは、さらに多くの情報を見つけるためのリソースも提供されました。ありがとうございます!
2024 年 3 月
技術ドキュメントに関する素晴らしいコースです。多くの新しいことを学びました。自分の仕事環境でも実践したいと思います。
2024 年 3 月
コースは受講しやすく理解しやすく、提供された参考資料も役立ち、他のドキュメントへの参照が多すぎて圧倒されることもありませんでした。
2024 年 2 月
情報は明確に説明されており、特にさまざまなユーザーに必要な情報を定義するセクションは、ソフトウェアに関連しない他の種類の製品のドキュメント化にも適用できます。
2024 年 2 月
高品質のドキュメントをうまく書くために何が必要かを俯瞰的に理解できてとてもよかったです。ありがとうございました!
2024 年 1 月
これにより、以前は欠けていたソフトウェア製品用の高品質なドキュメントを準備する方法についての概要が得られました。
2024 年 1 月
オープンソース/クローズドソース プロジェクトの技術ドキュメントの書き方に関するわかりやすくて優れた入門書です。
$0
登録する前にポータルを使用してログインする
オンライン、セルフペース
3 ～ 4 時間のコース教材
クイズ
オンラインコースへの無制限のアクセス
デジタル バッジ
