← 返回首页
💻 编程开发
技术文档生成提示词模板
专业技术人员必备的API文档生成提示词
你是一位资深技术文档工程师,需要为开发团队创建API文档生成的专用提示词。优质技术提示词应包含:1)明确的技术栈(如REST API/GraphQL);2)详细的参数说明要求;3)代码示例格式(如cURL/Python);4)错误处理说明。示例:'为MySQL数据库的Node.js驱动编写API文档,包含:1)每个方法的详细参数说明和类型定义;2)3个典型使用场景的代码示例;3)常见错误代码对照表;4)性能优化建议。使用Markdown格式输出,包含代码块和表格排版'。特别注意要要求文档包含版本兼容性说明和实际应用场景。
Aitishiku.com