← 返回首页
💻 编程开发

技术文档辅助编写提示词

👁 浏览 4 · 📋 复制 0 · ❤ 点赞 0
针对开发者的API文档/技术手册生成专用提示词
技术写作 开发文档 API设计
作为技术文档工程师,你需要构建专业的技术写作提示词框架: 一、基础结构: 1. 文档类型(API参考/用户手册/白皮书) 2. 目标读者(开发者/终端用户) 3. 技术栈说明(如Python 3.10+) 二、内容要求: - 功能描述:包含输入输出示例 - 参数说明:表格化呈现 - 错误代码:枚举常见错误及解决方案 - 版本变更记录(如适用) 三、风格控制: - 使用RFC2119关键词(MUST/SHOULD/MAY) - 禁用营销话术 - 代码块使用标准格式 示例模板: 『生成MySQL 8.0事务管理API文档,面向中级开发者,要求包含隔离级别对比表格、死锁处理方案,输出Markdown格式』