APIドキュメンテーション - Cloud

Talend Cloud API Designerユーザーガイド

EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend API Designer
task
ジョブデザインと開発 > Designing APIs
Talend Cloud API Designerを使ってAPIをドキュメント化できます。 ドキュメントは、APIのライフサイクルにおける重要なステップです。ドキュメントの作成と保守は困難な作業になり得ますが、Talend Cloud API Designerではドキュメントを自動的に取得できます。

誰がドキュメンテーションを書き、誰がそれを読みますか?

Talend Cloud API Designerでは、APIデザインの編集を許可されているAPIデザイナーのチームが作業します。チームメンバーは、APIのドキュメントに寄稿して公開できます。

公開されたドキュメントは、必要に応じてAPIコンシューマーに自由に配布できます。チームメンバー、パートナー、Web上のあらゆるユーザーが読者となります。