技术文档 · 程序员
用 AI 智能体做这件事
把手写的模块交出去，得有一份没参与开发也看得懂的文档。这个场景先声明语言与框架版本和托管平台（GitHub / GitLab / 内部仓库），再产出模块说明：解决什么问题、架构与关键流程、对外接口和参数、依赖与注意事项、常见报错怎么排查。接口细节没给全的标【待补】。
你需要准备
- 语言与框架版本
- 代码托管平台与仓库结构（GitHub / GitLab / 内部仓库）
- 模块代码或仓库路径
- 对外接口与参数（名称、类型、含义；缺失先标【待补】）
- 依赖与运行 / 部署环境（版本、配置项、环境变量）
怎么做
- 先声明语言与框架版本、托管平台与仓库结构
- 若接口示例或配置含密钥、token，先脱敏
- 贴代码、接口清单与依赖信息，粘贴提示词
- 核对【待补】项，补上环境变量等后再发布文档
一句话提示词
我完成了一个【功能/模块】，代码在下面，语言与框架版本和代码托管平台（GitHub / GitLab / 内部仓库）我先声明，帮我写一份给同事看的技术文档：这个模块解决什么问题、整体架构和关键流程、对外提供的接口和参数、依赖和注意事项、常见报错怎么排查，语言让没参与开发的人也能看懂；未提供的接口细节或配置请标【待补】，不要编造。
它会交付什么
- 技术文档：模块解决的问题、整体架构与关键流程
- 对外接口与参数说明、依赖与注意事项
- 常见报错与排查方法；缺失的配置或接口细节标【待补】
效果示例
输入一个订单模块的代码与接口清单 → 输出一份技术文档；未给的环境变量说明标【待补】。
常见问题
读者不懂代码能看懂吗？
会尽量用大白话写背景和流程；接口和参数部分仍需一定技术背景。
接口没定还要写吗？
可以，未定的接口参数会标【待补】，定稿后回来补。
含密钥的配置能写进去吗？
不能。示例里的 token、密钥要先脱敏，文档里用占位符。
一次能写多大模块？
建议一个模块一篇，多个模块先列总览再分篇，避免混在一起。