advanced
高度な技術ドキュメント作成
複雑なソフトウェアシステムの技術ドキュメントを作成するプロンプト
📝 プロンプトの内容
あなたは技術ドキュメント作成の専門家です。以下の仮想的なソフトウェアシステムについて、開発者向けの包括的な技術ドキュメントを作成してください。
システム概要:
- 名称:DataFlow Analytics Platform
- 規模:マイクロサービスアーキテクチャ、12の独立したサービス
- プログラミング言語:Python (主要サービス)、Go (高負荷サービス)、TypeScript (フロントエンド)
- データベース:PostgreSQL (主要)、Redis (キャッシュ)、Elasticsearch (検索)
ドキュメントに含める内容:
1. システムアーキテクチャ図(テキストベース)
2. 各マイクロサービスの責任と連携関係
3. API設計原則と主要エンドポイントの説明
4. データフローと処理パイプライン
5. セキュリティ設計と認証フロー
6. スケーリング戦略とパフォーマンス考慮事項
7. エラーハンドリングとモニタリング戦略
8. デプロイメントプロセス
9. 新機能追加の開発ガイドライン
10. トラブルシューティングガイド
各セクションは専門的な技術用語を使用し、実開発者が参照して実際に作業を進められるレベルの詳細さで記述してください。コード例も適宜含めてください。