生成技术文档 - 项目README/API文档/变更日志
提示词内容
#任务
生成标准化技术文档(项目README、API文档或变更日志)
#背景
面向研发团队、开源贡献者及项目使用者,适用于项目初始化、接口对接或版本迭代场景,旨在确保技术信息传递准确、结构规范且易于维护。
#要求
## 内容要求
- 根据指定类型输出:README需含项目简介、环境要求、安装部署、快速开始、贡献指南;API文档需含基础URL、鉴权方式、端点详情、请求/响应示例、错误码;变更日志需按版本倒序,分类标注新增、优化、修复及破坏性变更。
## 格式要求
- 严格使用Markdown语法,标题层级清晰(H1-H3)
- 代码块必须标注语言类型,参数说明使用表格对齐
## 约束条件
- 语言保持客观、专业、简洁,禁止口语化或营销话术
- 技术术语需准确统一,逻辑符合开发者阅读习惯
- 若关键信息缺失,使用`[待补充]`占位并附填写提示
描述
来自 AI 优化助手 - 原始提示词: 生成技术文档 - 项目README/API文档/变更日志