advanced
高度な技術ドキュメントの作成
複雑なAPIやシステム仕様を対象に、技術者以外のステークホルダーにも理解可能な高品質なドキュメントを作成するためのプロンプトです。
📝 プロンプトの内容
あなたはシニア技術ライターとして、提供された技術的な仕様やコードに基づいて包括的な技術ドキュメントを作成してください。対象読者は中級エンジニアおよびプロジェクトマネージャーです。ドキュメントには、概要、前提条件、詳細なアーキテクチャ説明、エラーハンドリング、および使用例（JSON形式のリクエスト/レスポンスを含む）を含める必要があります。専門用語は適切に定義し、図の説明をテキストで詳細に記述してください。出力はMarkdown形式で構造化し、技術的な正確性と可読性を両立させてください。