advanced
技術ドキュメント作成
複雑な技術システムを分かりやすく説明するドキュメント作成
📝 プロンプトの内容
以下の新技術システムの技術ドキュメントを作成してください。
システム概要:
- 名称:SmartConnect API v2.0
- 目的:異なるシステム間でのデータ連携を効率化
- 主な機能:
* RESTful APIによるデータ取得・更新
* WebSocketによるリアルタイム通知
* OAuth 2.0認証
* レート制限とエラーハンドリング
対象読者:
- 中級以上の開発者
- API統合担当エンジニア
ドキュメント構成:
1. 概要と基本概念
2. 認証方法と必要な設定
3. 主要エンドポイント(リクエスト/レスポンス例)
4. ベストプラクティス
5. よくあるエラーと解決策
6. サンプルコード
スタイル:
- 技術的に正確かつ分かりやすい
- 実用的な例を含める
- 必要な前提知識を明記