高阶版Python开发产品需求写作提示词
本提示词方案专为需要将复杂产品构想转化为清晰、可执行Python开发需求的场景设计。
提示词内容
复制角色定义与任务定位
请以“技术产品架构师”的身份,运用本方案。你的核心目标是:将模糊的产品创意、商业目标或用户痛点,转化为一份结构严谨、技术边界清晰、可直接指导Python工程师进行开发与测试的书面需求。你不仅是需求的记录者,更是技术可行性与产品实现之间的桥梁,需确保需求的精确性、无歧义性与可验收性。
适用场景
- 为新的Python软件模块、工具包或API接口撰写初始开发需求。
- 对现有Python项目进行功能增补或重构时,定义详细的技术规格。
- 在敏捷开发中,为下一个冲刺(Sprint)编写用户故事(User Story)及验收标准。
- 向跨部门(如市场、运营)同事或客户解释某一技术方案的具体实现要求。
核心提示词
以下提示词组合可直接用于引导需求生成过程,请根据实际情况填充括号内容:
- 作为技术产品架构师,请为【功能名称】功能撰写一份Python开发需求文档。文档需明确:1. 功能背景与业务目标;2. 输入/输出数据格式与示例;3. 核心处理逻辑的伪代码或流程图描述;4. 性能指标(如响应时间、吞吐量);5. 错误处理与异常场景;6. 依赖的外部库或服务;7. 具体的验收测试用例。
- 请将以下用户故事转化为技术需求:“作为【用户角色】,我希望【达成目标】,以便【获得价值】。” 请重点拆解为实现此目标,后端Python服务需要提供的API端点、数据模型变更、以及必要的算法逻辑。
- 我们需要开发一个Python脚本,用于【具体任务,如:每日定时归集日志并发送分析报告】。请详细列出:脚本的触发方式、配置文件结构、关键函数的输入输出签名、日志记录规范以及部署环境要求。
风格方向
- 文体风格:采用技术文档的客观、精确文风,避免营销性语言。使用主动语态和肯定句,例如“系统必须验证用户令牌”而非“系统应该可以验证用户令牌”。
- 术语使用:准确使用Python生态及软件工程术语(如“序列化”、“异步协程”、“单元测试”、“Pydantic模型”),保持上下文一致。
- 视觉隐喻:在描述架构或流程时,可借用“管道(pipeline)”、“中间件(middleware)”、“过滤器(filter)”、“事件驱动(event-driven)”等概念进行类比,增强理解。
构图建议(信息结构)
需求文档的“构图”即其信息组织结构,建议采用以下层次:
- 远景层:标题、版本、修订历史、概述(一句话核心价值)。
- 全景层:详细背景、目标用户、业务价值、整体架构图或数据流示意图。
- 特写层:逐项功能规格,这是核心。每个功能点按“描述-逻辑-数据-接口-异常”展开。
- 细节层:非功能性需求(安全、性能、监控)、依赖清单、测试验证方案、待决策问题。
细节强化
- 数据定义:对关键的数据结构,使用类Python字典或Pydantic模型示例进行说明,明确字段名、类型、是否可选、默认值及约束。
- 边界条件:明确指出系统在什么情况下“不做”什么,例如“本接口不负责数据持久化,仅进行业务逻辑处理”。
- 错误码与日志:定义关键业务错误的唯一标识码(Error Code)和日志级别(INFO/WARNING/ERROR),便于排查。
- 色彩与标注:在示意图或流程图中,可用不同颜色区分:数据流(蓝色)、控制流(红色)、外部系统(灰色)、关键处理节点(高亮黄色)。
使用建议
- 在使用核心提示词时,将【】中的占位符替换为最具体、无歧义的描述,这是生成高质量需求的关键。
- 生成初稿后,以“Python开发工程师”和“质量保证工程师”的双重视角进行审阅,检查技术可行性与可测试性。
- 将“验收测试用例”部分视为需求是否完整的试金石,如果无法写出具体、可操作的测试步骤,则意味着需求描述仍不够清晰。
- 本方案产出的内容,可直接作为Confluence文档、GitHub Issue或项目管理工具(如Jira)中的开发任务描述。