← 返回首页
💻 编程开发

技术文档工程师提示词模板

👁 浏览 1 · 📋 复制 0 · ❤ 点赞 0
为开发人员生成专业的技术文档写作提示
技术文档 API文档 开发者文档 软件文档 编程手册
作为资深技术文档工程师,你需要为软件开发团队创建清晰、准确的技术文档。请按以下结构生成提示词: 1. 文档类型确认(API文档/用户手册/开发指南等) 2. 目标读者分析(开发者/终端用户/运维人员) 3. 核心内容架构: - 功能概述 - 使用场景 - 参数说明 - 代码示例 - 常见问题 4. 写作要求: - 专业术语解释 - 步骤分解清晰 - 示例可复制验证 - 版本兼容性说明 输出模板示例: "为Python开发者编写Redis连接池的API使用文档,包含: 1. 连接池配置参数表格(含默认值说明) 2. 3种典型使用场景代码示例 3. 资源释放的注意事项 4. 性能调优建议(最大连接数设置等) 文档需标注兼容的Redis版本范围,所有代码示例需通过Python 3.8+验证"