测试工程产品说明文档清晰框架提示词

角色定义与任务定位

请以资深测试架构师兼技术文档负责人的身份进行创作。你的核心目标是：为软件测试相关的工程产品或工具（如自动化测试平台、缺陷管理系统、性能监控工具等）撰写一份逻辑清晰、内容完整、面向多角色读者（开发者、测试员、项目经理）的产品说明文档。这份文档需兼具技术准确性与业务可读性，旨在降低团队理解成本，提升协作与实施效率。

适用场景

• 为内部开发的测试工具编写正式使用说明。
• 为商业测试软件或SaaS服务撰写产品功能文档。
• 在项目交接或新成员入职时，提供核心测试产品的标准化操作指南。
• 为开源测试框架补充结构化的产品化说明。

核心提示词

（以下提示词可直接组合使用，作为文档生成的核心指令）

• 文档标题与概述：“撰写《[产品名称]测试工程产品说明文档》。开篇提供产品概述，明确说明本产品的核心定位（例如：一款用于API自动化测试与持续集成的平台），并列出文档的主要读者对象与阅读目标。”
• 核心功能模块说明：“分章节详细说明产品的核心功能模块。例如：‘测试用例管理’、‘自动化执行引擎’、‘测试报告与分析’、‘集成与配置’。每个模块需包含功能描述、解决的主要痛点、典型操作流程或示例。”
• 环境与部署要求：“以清单或表格形式，清晰列出软件/硬件依赖、系统环境要求（如Python 3.8+， Docker）、网络配置以及详细的部署或安装步骤。”
• 实战应用指南：“提供一个从‘创建第一个测试项目’到‘执行测试并查看报告’的完整端到端（End-to-End）实战教程。包含关键配置截图（描述）、代码片段示例（如YAML配置或测试脚本）和结果解读。”
• 常见问题与故障排查：“整理一份FAQ，涵盖安装、配置、执行中的常见错误。提供问题现象、根本原因分析及具体的解决步骤。”

风格方向

• 语言风格：专业、准确、简洁。避免过度口语化，但需避免晦涩难懂的技术黑话。采用主动语态和肯定句式。
• 文档结构：层次分明，采用“总-分”结构。大量使用标题层级（H1, H2, H3）、编号列表、项目符号和表格来组织信息。
• 视觉基调：理性、可靠、高效。想象文档使用清晰的代码高亮、简洁的架构图或流程图进行辅助说明。

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

• 封面/首页：产品名称、版本号、撰写/修订日期、目标读者。
• 文档历史：版本修订记录表（版本、日期、修改内容、修改人）。
• 正文结构建议：
  • 1. 产品简介（概述、目标、读者）
  • 2. 系统架构与设计原则（可选，技术深度文档需要）
  • 3. 功能详述（分模块）
  • 4. 快速开始（实战教程）
  • 5. 高级配置与最佳实践
  • 6. API参考或命令行指南（如适用）
  • 7. 常见问题与故障排查
  • 8. 附录（术语表、资源链接）

细节强化

• 关键词强调：在文中合理使用“关键前提”、“请注意”、“重要”、“不建议”等词语来提示风险或重点。
• 示例具体化：所有示例应基于一个假想的统一场景（如“测试一个用户登录接口”），保持上下文连贯。
• 接口与配置：对于配置项，说明其默认值、可选范围、以及修改后的影响。
• 结果可视化描述：描述报告应包含的关键指标（如通过率、缺陷分布、性能趋势图）及其业务含义。

使用建议

• 生成初稿后，请根据实际产品细节，替换提示词中的“[产品名称]”和示例内容。
• “核心提示词”部分可以分段输入给AI，以生成不同章节，再人工整合与润色，确保逻辑流畅。
• 对于“实战应用指南”章节，建议先列出步骤大纲，再为每一步骤填充具体操作和示例代码。
• 定期根据产品迭代更新“文档历史”和“常见问题”部分，保持文档的时效性。