专业版Python开发API封装说明提示词

角色定义与任务定位

请以“资深Python后端架构师”或“API接口设计专家”的身份，来使用这份提示词。你的核心目标是：为即将发布或已完成的Python API封装模块，生成一份逻辑清晰、内容完备、便于开发者理解与集成的技术说明文档。这份文档应直接服务于开发团队的协作、下游用户的接入以及项目的长期维护。

适用场景

• 为开源或内部Python库的API封装模块撰写官方使用说明。
• 在项目文档中，为关键服务层或工具类的封装代码提供专项说明。
• 编写面向其他开发者的API接口集成指南或SDK使用手册。
• 重构旧有API封装时，用于产出新版本文档。

核心提示词

以下提示词组合可直接用于引导文档生成，请根据实际情况填充或调整 `{ }` 中的内容：

• “撰写一份关于 `{Python模块名}` API封装的说明文档，重点阐述其设计目的、核心类 `{ClassName}` 的初始化参数、主要方法 `{method1, method2}` 的签名、返回值及异常处理。”
• “以‘快速入门’、‘核心接口详解’、‘高级配置’、‘错误代码表’为结构，生成 `{功能领域}` API封装的使用指南。”
• “生成结构化API说明，包含：1. 概述与特性；2. 安装与导入；3. 基础使用示例代码片段；4. 参数列表表格（参数名、类型、必填、描述）；5. 返回数据格式说明。”

风格方向

• 文体风格：采用技术文档的客观、精确、简洁文风，避免营销口吻和模糊表述。使用现在时态和主动语态。
• 结构层次：文档结构应模块化、层级分明，建议采用“概述-快速开始-深度解析-参考”的递进逻辑。
• 术语与一致性：保持专业术语的一致性，对首次出现的核心概念可加粗并给出简短解释。

构图建议（信息组织框架）

• 顶部摘要：用一段话精炼概括该API封装的核心价值、解决的主要问题及其在技术栈中的位置。
• 主体模块纵向排列：将信息按逻辑顺序垂直排列，例如：安装 -> 初始化 -> 核心方法调用 -> 高级特性 -> 故障排查。
• 代码与文本穿插：在每个关键步骤或接口说明后，立即提供可运行的、简洁的Python代码示例，形成“说明-示例”的紧密组合。
• 侧边导航（逻辑上）：通过清晰的标题（H2, H3）和锚点，在长文档中构建隐形的“侧边导航”，方便快速跳转。

细节强化

• 代码高亮：确保所有Python代码片段语法正确，并标识出关键参数和修改点。
• 参数表格化：对函数参数、配置项、返回值字段，使用Markdown表格呈现，包含字段名、类型、默认值、说明四列。
• 异常枚举：明确列出接口可能抛出的异常类型及其触发条件，并给出处理建议。
• 版本标注：对新增、废弃或更改的接口，明确标注其起始版本号，如 `(v1.2+)` 或 `[Deprecated]`。
• 扩展链接：在文档末尾或相关章节，提供指向更底层实现、相关依赖库官方文档或完整项目地址的链接。

使用建议

• 在使用核心提示词时，尽可能具体化 `{ }` 中的变量，生成的文档将更具针对性。
• 可先使用“核心提示词”生成草稿，再依据“风格方向”和“细节强化”进行润色与结构化调整。
• 将最终输出的文档视为“最小可用产品”，可邀请一位目标开发者快速阅读，根据其反馈在“使用示例”和“常见问题”部分进行增补。
• 本方案同样适用于为类似功能的API封装生成说明，只需替换核心领域关键词即可。