技术文档写作 Prompt

技术文档写作 Prompt 是一套指导 AI 生成高质量技术文档的提示词框架，涵盖从需求理解、结构规划、内容撰写到格式规范的全流程指导，适用于 API 文档、README、开发指南和架构说明等各类技术文档。

文档结构模板

📄 技术文档标准结构

1. 概述（Overview）
   - 文档目的和目标读者
   - 核心概念和前置知识

2. 快速开始（Quick Start）
   - 前置要求（环境/依赖）
   - 最小可运行示例
   - 预期输出验证

3. 核心功能（Features）
   - 功能1：使用场景 + 示例代码
   - 功能2：使用场景 + 示例代码

4. API 参考（API Reference）
   - 接口列表（名称、参数、返回值）
   - 详细参数说明
   - 错误码表

5. 最佳实践（Best Practices）
   - 常见使用模式
   - 性能优化建议
   - 安全注意事项

6. FAQ / Troubleshooting
   - 常见问题及解决方案

7. 变更历史（Changelog）
   - 版本号 + 更新内容

写作原则

• 目标读者优先：API 文档面向开发者，README 面向用户
• 代码即文档：用可运行的最小示例代替大段文字说明
• 渐进式展开：从"最快能跑起来"到"完整功能参考"
• 版本同步：文档版本号与代码版本保持一致

好的技术文档是产品的名片，一份结构清晰、内容准确、示例丰富的文档能大大降低用户的学习成本，提高产品的采用率。