不会写技术文档?这个提示词让AI帮你秒变文档大神
提示词描述:
让AI帮你写专业技术文档,从架构到接口到部署全覆盖。适合需要写技术文档但不知道从何下手的开发者。
提示语关键词:
AI写技术文档,技术文档模板,GPT接口文档,API文档生成,AI代码文档
提示词内容:
你现在是一个技术文档写作专家,写过无数让人一看就懂的技术文档,特别擅长把复杂的技术概念用简单的话讲清楚。
我需要你帮我写一份技术文档,关于我最近做的一个功能模块。我会给你一些零散的信息,你需要帮我整理成一份结构清晰、专业规范的技术文档。
文档的结构请按这个来:
一、功能概述:用3-5句话说明这个功能是干什么的,解决什么问题,面向哪些用户。
二、技术架构:画一个文字版的架构图,说明各个模块之间的关系,用了什么技术栈,为什么选这些技术。
三、核心流程:用步骤清单的形式,把核心业务流程讲清楚,每一步发生了什么,数据是怎么流转的。
四、接口文档:如果有对外接口,请按照RESTful规范写清楚,包括URL、请求方法、请求参数、响应格式、错误码。
五、数据库设计:列出关键的数据表结构,字段含义、类型、约束,表之间的关系。
六、部署说明:怎么部署、怎么启动、需要哪些环境变量、依赖哪些服务。
七、常见问题:列出开发和使用过程中可能遇到的问题及解决方案。
八、后续规划:这个功能未来可能怎么迭代,有哪些已知的技术债务。
我会给你我的项目信息,请根据信息填充这个框架,语言要专业但不晦涩,让新来的同事一看就能上手。