文档说明
0.1 手册目标
本手册帮助读者从认识 CodeFlow、完成首次接入,到逐步掌握会话协作、知识库构建、需求编排、资产库管理、企业协作、系统设置和交付审查。
CodeFlow 的使用过程横跨 Web 工作台、Client 本地代理和工作区。手册围绕真实产品入口和操作结果展开,帮助读者理解从哪里开始、如何推进、完成后能看到什么。
本手册重点覆盖四类目标:
- 快速跑通最小使用闭环:注册登录系统,完成 Client 安装向导,创建工作区,配置大模型 Key,完成第一条会话和第一条需求。
- 深入掌握日常会话:在会话工作台中输入任务、引用文件、查看消息流、审查文件变更、使用 Git 和终端,并在必要时中断、回滚或人工接管。
- 建立项目知识库:通过知识库构建沉淀业务规则、工程规范、历史需求和源码事实,让后续会话、需求分析和开发交付有稳定依据。
- 通过团队协作完成端到端AI全流程交付:围绕需求编排、资产库、共享空间、成员权限、运行证据和审计记录,把自然语言诉求推进到可验收、可追踪、可复用的交付结果。
0.2 目标读者
| 读者 | 主要关注内容 |
|---|---|
| 产品经理 | AI 需求分析、工作流、交付结果审查等 |
| 研发人员 | 会话协作、文件变更、Git 管理、终端等 |
| 测试人员 | 需求验收、运行证据、产出物检查、问题复现和回归确认 |
| 团队负责人 | 知识库建设、资产复用、共享空间、成员权限、审计记录和团队规范沉淀 |
0.3 推荐阅读路径
读者可以按当前目标选择阅读路径,不需要从头到尾一次读完。
flowchart TD
Start{阅读目标}
Start --> NewUser[第一次使用]
NewUser --> Intro[1 产品概览]
Intro --> QuickStart[2 快速开始]
QuickStart --> Workbench[3 会话工作台]
Workbench --> FirstDelivery[5 需求与编排]
Start --> DeliveryOwner[端到端AI交付]
DeliveryOwner --> Knowledge2[4 知识库构建]
Knowledge2 --> Orchestration[5 需求与编排]
Orchestration --> Assets[6 资产库管理]
Assets --> Evidence[11 最佳实践]
Start --> TeamAdmin[企业团队协作]
TeamAdmin --> Enterprise[7 企业管理]
Enterprise --> Shared[7.5 共享空间管理]
Shared --> Security[10 安全与审计]
Start --> Troubleshooting[遇到问题]
Troubleshooting --> Settings[9 系统设置]
Settings --> FAQ[12 常见问题与排障]
推荐路径可以按目标理解为:
- 第一次使用:先完成产品概览和快速开始,再进入会话工作台熟悉日常操作,随后阅读需求与编排。
- 推进端到端交付:重点阅读知识库构建、需求与编排、资产库管理和最佳实践。
- 团队协作:重点阅读企业管理、共享空间管理和安全与审计。
- 遇到问题:先查看系统设置,再进入常见问题与排障。