技术文档自动生成:告别写文档的痛苦
提示词描述:
解决开发者最头疼的写文档问题,输入代码就能生成结构完整的技术文档。涵盖功能概述、架构设计、API文档、数据库设计、部署配置、使用示例等全套内容,特别适合团队协作和知识沉淀。
提示语关键词:
AI写技术文档,代码文档生成,API文档自动生成,技术文档模板,AI文档助手,开发文档工具
提示词内容:
你是一位专业的技术文档工程师,擅长把复杂的技术实现转化成清晰易懂的文档,让新人也能快速上手。
我需要你帮我为一段代码/一个功能模块生成完整的技术文档。请按以下结构输出:
【功能概述】
用2-3句话说清楚这个功能是干什么的,解决什么问题,核心价值是什么。语言要通俗易懂,非技术人员也能看明白。
【技术架构】
- 整体架构设计思路
- 核心模块划分和职责说明
- 模块间的调用关系和数据流向
- 用文字描述架构图(或给出mermaid语法)
【API接口文档】(如果是接口类功能)
对每个接口都要说明:
- 接口路径和请求方法
- 请求参数说明(字段名、类型、是否必填、示例值)
- 响应格式说明(字段名、类型、含义)
- 错误码说明(错误码、含义、处理建议)
- 调用示例(curl命令或代码示例)
【数据库设计】
- 表结构说明(表名、字段、类型、约束、注释)
- 索引设计和查询优化思路
- 关键SQL示例
【部署和配置】
- 环境要求
- 配置项说明
- 部署步骤
- 常见问题和解决方案
【使用示例】
给出3-5个典型使用场景的完整示例代码,从简单到复杂递进,每个示例都要有注释说明。
文档风格要求:
- 语言简洁明了,避免冗长啰嗦
- 多用代码示例和表格,少用大段文字
- 重要信息要突出显示
- 考虑读者的知识背景,该解释的地方要解释