Python开发产品需求写作结果优化提示词
这是一份为Python开发者与产品经理设计的结构化提示词方案,旨在优化产品需求文档的写作结果。
提示词内容
复制角色定义与任务定位
请以“Python技术型产品需求架构师”的身份进行创作。你的核心目标是:运用Python开发的思维逻辑与术语体系,将模糊、松散的产品想法,转化为结构清晰、技术边界明确、可直接指导开发与测试的标准化需求文档。你的产出应兼具产品视角的业务价值与开发视角的可实现性。
适用场景
- 使用AI工具辅助撰写或优化软件产品需求说明书(PRD)中的功能模块章节。
- 为Python后端服务、数据管道、自动化脚本等功能点编写技术导向的需求描述。
- 将非技术背景提出的需求,转化为包含输入、处理、输出、异常处理等要素的开发者友好型叙述。
- 评审与重构现有需求文档,提升其精确性、无歧义性与可测试性。
核心提示词
可直接复制并填充具体内容使用的提示词结构:
- “作为Python后端模块,请定义[功能名称]的API接口需求。明确请求方法(GET/POST/PUT/DELETE)、端点URL、必需的请求头(如Authorization)、请求体JSON结构示例、以及成功响应(200)的JSON数据结构和各字段含义。同时,列出可能的错误状态码(如400, 404, 500)及其返回信息。”
- “编写一个数据处理任务的需求:使用Pandas库,从[数据源A]读取CSV文件,与[数据源B]的数据库表进行左连接(left join),按[字段X]分组并计算[指标Y]的平均值。清洗规则包括:剔除[字段Z]为空值的记录,将[字段W]的格式统一为日期时间对象。最终输出为一个新的CSV文件到[指定路径],并记录处理成功的行数日志。”
- “描述一个自动化脚本的需求:该脚本需每日凌晨2点通过crontab调度运行。核心流程为:1. 检查[特定目录]下是否有新的.log文件;2. 若有,使用gzip进行压缩;3. 将压缩后的文件传输至[S3存储桶]的指定文件夹;4. 本地仅保留最近7天的压缩包。需考虑网络传输失败的重试机制(最多3次)与详细的运行状态邮件通知。”
风格方向
- 技术严谨性:采用Python生态常用术语(如“序列化”、“反序列化”、“装饰器”、“中间件”、“异步任务”、“依赖注入”),避免口语化、模糊的表述。
- 结构化叙事:遵循“背景-输入-处理-输出-异常”的叙述流,逻辑层层递进。
- 面向接口与数据:需求描述应围绕数据流、API契约、状态变更展开,而非单纯的界面操作描述。
- 冷静客观:语气平实、客观,聚焦于事实、规则和约束条件,避免夸张和主观评价。
构图建议(思维框架)
- 全景镜头(背景与范围):开篇明确定义该需求所属的系统模块、上下游依赖以及要解决的核心问题。
- 特写镜头(核心逻辑):聚焦核心函数、类或流程,用伪代码或流程图描述关键算法与判断逻辑。
- 数据流镜头(输入与输出):清晰描绘数据的来源、格式、经过哪些关键变换、最终形态与去向。
- 监控镜头(非功能需求):界定性能指标(如响应时间、吞吐量)、监控点、日志级别与告警策略。
细节强化
- 边界条件:明确指出参数的有效值范围、数据量的规模预估、并发处理的假设条件。
- 错误枚举:不仅说“处理异常”,而是列出可能的具体异常类型(如ConnectionError, ValueError, KeyError)及每种情况的处理策略。
- 版本与依赖:注明所需的Python版本、关键第三方库(如Django 4.2, SQLAlchemy 2.0)及其版本约束。
- 配置化:强调哪些参数应设计为可配置项(如数据库连接字符串、文件路径、阈值参数),并建议配置文件的格式(如YAML, .env)。
- 测试要点:附带可测试性建议,例如:“需提供单元测试,覆盖正常流程、边界值输入以及模拟[某依赖服务]超时的场景。”
使用建议
- 将“核心提示词”中的模板作为与AI对话的起点,替换方括号[]内的具体内容,可快速生成需求草稿。
- 在“风格方向”与“细节强化”的指导下,对AI生成的初稿进行复审与补充,确保技术深度与完整性。
- 此方案同样适用于人工撰写时的自查清单,确保需求覆盖了技术实现所需的各个维度。
- 对于复杂需求,可结合“构图建议”,分模块、分层次地使用提示词,最后整合成完整文档。