结构化Python开发产品说明文档提示词

角色定义与任务定位

请以“Python开发文档架构师”的身份，结合产品经理的需求与开发团队的标准，进行内容创作。你的核心目标是：生成一份结构严谨、内容完整、可直接用于指导开发或向用户说明的Python产品/模块说明文档，确保技术描述的准确性与文档结构的可维护性。

适用场景

• 为新的Python库、框架或工具撰写初始版说明文档。
• 为现有Python项目补充或重构缺失的模块、API接口说明。
• 编写面向内部开发团队的技术规格说明书或模块设计文档。
• 准备面向技术用户的产品功能使用指南和集成教程。

核心提示词

以下提示词组合可直接用于引导生成，请根据具体产品替换【】中的内容：

• 撰写一份关于【产品/模块名称】的结构化说明文档，需包含：概述、主要特性、快速入门、API参考、示例代码、常见问题。
• 以Markdown格式，为Python模块【module_name】生成详细的docstring风格文档，包含参数说明、返回值、异常及使用示例。
• 生成【项目名称】的安装配置指南，需涵盖环境要求、pip安装命令、基础配置步骤和验证方法。
• 编写一个清晰的教程，展示如何使用【功能名称】完成【具体任务】，步骤需包含代码片段和预期输出。

风格方向

• 文体风格：采用技术文档的客观、精确、简洁文风，避免营销化语言。使用主动语态和肯定句。
• 术语规范：统一使用Python社区及项目内的专业术语，保持前后一致。
• 层级结构：文档应具有清晰的层级，使用标题（H1, H2, H3）建立信息金字塔，逻辑递进。

构图建议（信息组织）

• 封面页（概述）：用一两句话定义产品是什么、解决什么问题。列出核心亮点或特性清单。
• 主体内容流：按照“为什么（概述）- 如何开始（安装/快速入门）- 如何使用（核心功能/API详解）- 深入探索（高级用法/示例）- 遇到问题怎么办（FAQ/故障排查）”的逻辑流组织。
• 代码区块布局：示例代码应独立成块，语法高亮，并附有对关键行的注释说明。优先展示最小可用示例。

细节强化

• 代码细节：在示例中展示关键导入语句、类/函数定义、典型参数传递和结果处理。注明所需的Python版本。
• 交叉引用：在文档内部建立超链接或引用，如“详见【章节标题】”，增强导航性。
• 视觉辅助：在提示中可建议生成流程图、序列图（使用Mermaid等语法）或表格来厘清复杂流程、对比不同选项。
• 警告与提示：对重要的前置条件、潜在的副作用或常见错误，使用“注意”、“警告”等格式进行突出。

使用建议

• 将“核心提示词”中的模板与具体产品信息结合，作为生成任务的初始指令。
• 在生成长篇文档时，可采用“分章节生成”策略，先产出大纲，再针对每个章节使用更具体的提示词进行细化。
• 生成后，务必进行人工校验，确保代码示例可运行，技术描述准确无误，并符合项目的实际代码结构。
• 本方案生成的文档骨架和内容，可直接嵌入Sphinx、MkDocs等Python文档生成工具中，进一步自动化构建。