文档自动化

# 代码到文档转换生成模板

## 前提条件
- 源代码 [插入源代码或指定文件路径]
- 编程语言: [编程语言]
- 文档格式: [Markdown/HTML/PDF等]
- 目标受众: [初级/中级/高级开发者]

## 需求描述要点
- 文档概述:
  * 代码的总体功能和目的
  * 核心概念和术语解释
  * 设计原则和模式说明
- 结构分析:
  * 代码结构和组成
  * 关键组件和模块
  * 依赖关系
- 接口文档:
  * 公共API详细说明
  * 参数和返回值定义
  * 异常处理说明
  * 使用示例
- 实现细节:
  * 关键算法说明
  * 重要逻辑流程
  * 性能考虑
  * 限制和约束
- 使用指南:
  * 安装和配置说明
  * 基本使用流程
  * 常见使用场景
  * 最佳实践建议

## 输出格式
- 格式: 结构化技术文档
- 章节: 使用清晰的标题层级
- 代码示例: 添加格式化的代码示例
- 图表: 提供关系图和流程图建议

## 其他要求
- 确保文档简洁明了
- 避免复制粘贴代码而不解释
- 突出重要的设计决策和注意事项
- 包含必要的参考链接
                        

# 流程图生成模板

## 前提条件
- 流程名称: [流程或算法名称]
- 流程类型: [业务流程/算法/系统交互等]
- 图表格式: [PlantUML/Mermaid/其他]
- 复杂度级别 [简单/中等/复杂]

## 需求描述要点
- 流程概述:
  * 简要描述流程的目的和功能
  * 流程的起点和终点
  * 整体流程的参与者或系统
- 流程步骤:
  * 详细列出所有流程步骤
  * 每个步骤的输入和输出
  * 分支条件和决策点
  * 循环和重复部分
- 交互详情:
  * 系统或参与者之间的交互
  * 数据流向
  * 消息传递方式
  * 同步/异步处理
- 异常流程:
  * 可能的异常情况
  * 错误处理方式
  * 恢复和回滚机制
- 时序信息:
  * 关键步骤的顺序依赖
  * 并行执行的可能性
  * 关键路径标识

## 输出格式
- 格式: PlantUML/Mermaid代码和图形描述
- 布局: 清晰的流程布局建议
- 注释: 解释关键决策点和复杂部分

## 其他要求
- 使用合适的图表类型(流程图/时序图/状态图)
- 确保图表简洁且易于理解
- 使用一致的符号和命名约定
- 提供图表代码和渲染指南
                        

# 自动 API 文档生成模板

## 前提条件
- API 名称: [API名称]
- API 版本: [版本号]
- API 风格: [RESTful/GraphQL/gRPC等]
- 接口代码: [接口代码或描述]

## 需求描述要点
- 基本信息:
  * API标题和描述
  * 版本信息
  * 联系信息和许可证
  * 文档基础URL
- 服务器信息
  * 可用环境(开发/测试/生产)
  * 服务器URL
  * 服务器描述
- 认证与安全:
  * 认证方法描述
  * 安全方案定义
  * 范围和权限说明
- 端点详情:
  * 完整的端点列表和分组
  * 路径参数定义
  * 查询参数定义
  * 请求体模式
  * 响应模式
  * 状态码说明
  * 错误处理
- 通用模式:
  * 复用的数据模型
  * 参数和响应结构
  * 枚举值和常量

## 输出格式
- 格式: OpenAPI 3.0规范(YAML或JSON)
- 结构: 符合标准的文档结构
- 示例: 包含请求和响应示例

## 其他要求
- 确保文档的完整性和一致性
- 提供足够的描述和示例
- 考虑不同端点之间的关系
- 确保文档可以在标准工具中渲染
                        

# 用户手册生成模板

## 前提条件
- 产品名称: [产品或服务名称]
- 产品版本: [版本号]
- 目标用户: [初级用户/高级用户/管理员等]
- 平台: [Web/移动/桌面/多平台]

## 需求描述要点
- 手册概述:
  * 产品简介和目的
  * 主要功能摘要
  * 目标受众
  * 手册使用说明
- 入门指南:
  * 安装和设置步骤
  * 初始配置
  * 用户注册/登录流程
  * 界面导航概述
- 功能详解:
  * 完整的功能列表
  * 每个功能的详细使用说明
  * 功能之间的关系
  * 快捷键和高级操作
- 工作流程:
  * 常见任务的步骤指南
  * 使用场景和示例
  * 最佳实践建议
  * 提示和技巧
- 故障排除:
  * 常见问题解答
  * 错误消息说明
  * 故障排除步骤
  * 获取帮助的方法

## 输出格式
- 格式: 结构化用户手册
- 章节: 清晰的分章节结构
- 图片: 描述应包含的截图位置
- 索引: 提供关键术语索引

## 其他要求
- 使用简明易懂的语言
- 避免使用过多技术术语
- 包含必要的警告和注意事项
- 考虑不同用户角色的需求