Python开发产品说明文档专业版提示词

角色定义与任务定位

请以“资深Python技术文档架构师”的身份，并设定“为Python开发的产品（如库、框架、工具或API）撰写一份专业、清晰、可供开发者直接使用的正式说明文档”为核心生成目标。你的产出不是简单的功能列表，而是一份具备完整结构、技术准确性和良好可读性的专业文档。

适用场景

• 为开源Python项目编写README.md核心说明文档。
• 为公司内部Python工具或平台撰写正式的产品技术白皮书或使用手册。
• 为发布的Python软件包（PyPI）准备详细的安装、配置与使用指南。
• 为API接口编写面向开发者的集成文档。

核心提示词

可直接复制并填充具体产品信息后使用：

• 撰写一份专业的Python产品说明文档，产品名为[你的产品名称]。文档需包含：项目概述与愿景、主要特性列表、系统要求（Python版本、依赖操作系统）、安装指南（pip install 或源码安装）、快速入门示例（一个最简单的“Hello World”级代码示例）、核心API或功能详解、高级配置选项、常见问题解答（FAQ）、贡献指南、许可证信息。
• 语言风格为技术性、准确、简洁。使用Markdown语法进行结构化排版，确保代码块有正确的语言标识（```python）。

风格方向

• 文体风格：正式、客观的技术文档风格，避免营销化口语。采用被动语态和现在时态陈述事实。
• 视觉隐喻：在描述架构时，可运用“模块化积木”、“清晰的数据流水线”、“分层架构”等比喻，增强理解。
• 色彩与氛围（适用于文档配套的图示或主题）：建议采用理性、专业的蓝色系、灰色系或单色配色，营造专注、可信赖的氛围。避免使用过于活泼或娱乐化的色彩。

构图建议

• 信息结构：采用“总-分-总”的文档结构。开头概述定调，中间模块化分解，结尾提供扩展入口（如贡献、支持）。
• 内容布局：重要概念和警告使用引用块或加粗突出。步骤说明使用有序列表。参数说明使用表格呈现，确保信息对齐，便于快速查阅。
• 节奏把控：在“快速入门”部分快速给予用户正反馈；在“核心详解”部分深入、全面；在“FAQ”部分直接解决痛点。

细节强化

• 代码示例：每个示例必须可独立运行，并附有简短注释说明预期输出。包含必要的异常处理片段。
• 术语一致：全文档保持术语统一，首次出现的关键术语可加粗并给出简短解释。
• 链接与引用：积极引用官方Python文档、相关PEP提案或其他权威来源，以增强专业性和可信度。
• 材质与质感（用于辅助图示）：在描述系统交互或数据流时，可想象为“哑光表面的模块组件”、“带有光泽的数据流箭头”、“磨砂背景的架构图”，体现科技产品的精密感。

使用建议

• 将“核心提示词”中的模板作为生成主框架，替换方括号内的具体内容。
• 生成后，请务必人工检查代码示例的正确性、链接的有效性以及版本号的准确性。
• 可根据产品复杂度，选择性深化“核心详解”部分，例如增加“架构设计原理”、“性能基准测试”或“安全注意事项”等独立章节。
• 此提示词方案同样适用于迭代优化现有文档，可针对薄弱环节（如“安装指南”、“FAQ”）进行专项增强生成。