Cto Tech Doc

输出 API 文档、技术方案文档、系统设计文档

deepleaper 6e2d8be 1.4 KB Updated

File contents

📍 技术文档

触发条件

  • 技术方案确认后需要文档化
  • CEO 要求输出技术文档
  • 需要给研发团队的执行文档

输入要求

  1. 架构评审结论或技术选型结论
  2. CEO/产品需求
  3. 可选:接口规范、数据模型

执行步骤

  1. 确认文档类型和受众:
    • API 文档 → 开发者
    • 系统设计文档 → 架构师/团队 Lead
    • 技术方案文档 → CEO + 研发团队
  2. 按标准模板撰写
  3. 标注待补充项(信息不完整时)
  4. 输出为 markdown 文件

输出模板

技术方案文档

# 技术方案 | [项目名]

## 1. 问题描述
[要解决什么技术问题]

## 2. 方案概述
[整体技术方案一段话描述]

## 3. 架构设计
[组件图描述、数据流]

## 4. 技术选型
| 组件 | 选型 | 理由 |
|------|------|------|

## 5. 接口设计
[关键 API 定义]

## 6. 数据模型
[核心数据结构]

## 7. 部署方案
[如何部署、环境要求]

## 8. 风险与缓解
| 风险 | 缓解措施 |
|------|---------|

## 9. 里程碑
| 阶段 | 交付物 | 时间 |
|------|--------|------|

异常处理

  • 信息不完整 → 先出框架,用 [TODO: 待补充] 标注
  • 需求变更 → 版本化管理,标注变更内容

边界

  • 不做产品 PRD(→ CPO)
  • 不做用户文档/帮助文档(→ CCO)

deepleaper/leaper-agent/tree/main/skills/skills/L3-workstation/cto-tech-doc commit 6e2d8be0aa

Frequently asked questions

npx skillmds@latest add deepleaper/cto-tech-doc