txcode操作文档 文档中心

软件研发

软件研发模块提供完整的需求分析、方案设计、代码生成和测试验收工作流程。

进入研发页面

  1. 启动 txCode Web 服务:
txcode web
  1. 浏览器打开 http://localhost:40000
  2. 点击顶部导航的 研发 进入工作流页面

工作流程概览

研发模块分为 4 个步骤:

步骤 说明
1. 新建需求 创建和管理需求项目
2. 方案设计 与 AI 协作编写方案文档
3. 代码生成 根据方案生成代码
4. 测试验收 测试功能是否按方案实现

步骤一:新建需求

创建大类

大类用于对需求进行分类管理:

  1. 点击 "新建" 按钮
  2. 输入大类名称(如:用户管理、订单系统)
  3. 点击 "确定"

创建需求

  1. 选择所属大类
  2. 点击 "新建" 按钮
  3. 输入需求名称(如:用户登录、订单查询)
  4. 点击 "确定"

创建需求后,系统会自动:

  • 创建需求目录
  • 生成 {需求名}_方案.md 方案文档
  • 创建 3 个独立会话(设计/代码/测试)

步骤二:方案设计

界面说明

  • 左侧:Monaco Editor 编辑器,用于编写和查看方案文档
  • 右侧:AI 对话面板,与 AI 协作完善方案

操作步骤

  1. 编写方案

    在左侧编辑器中编写方案,方案文档包含:

    # 用户登录方案
    
    > 所属大类:用户管理
    
    ## 业务目标
    
    ## 功能点
    
  2. 与 AI 协作

    在右侧输入框描述需求,AI 会:

    • 分析需求并给出建议
    • 更新方案文档
    • 使用工具完成文件操作
  3. 保存方案

    • 点击 "保存方案" 按钮
    • 或按 Ctrl+S 保存
  4. 刷新方案

    点击 "刷新方案" 重新加载方案文档

快捷操作

功能 操作
发送消息 Enter
换行 Ctrl+Enter
选择文件 @ 触发文件选择器
保存方案 Ctrl+S

状态栏信息

  • 状态:思考中 / 就绪
  • 模型:当前使用的 AI 模型
  • 会话:会话 ID
  • token:当前 prompt 消耗

步骤三:代码生成

操作步骤

  1. 点击 "根据方案生成代码" 按钮
  2. AI 会自动读取方案文档并开始生成代码
  3. 在对话面板中查看生成进度
  4. 可以随时输入额外要求

快速开始

# 自动填入生成命令
根据 {方案路径} 方案开发相应功能,先不要修改方案文档。

功能按钮

按钮 说明
根据方案生成代码 自动读取方案生成代码
动作配置 配置自定义动作

自定义动作

可以配置预设的指令:

  1. 点击 "动作配置"
  2. 添加自定义动作名称和提示词
  3. 勾选 "自动发送" 可一键执行

步骤四:测试验收

操作步骤

  1. 点击 "根据方案测试" 按钮
  2. AI 会根据方案测试已生成的代码
  3. 查看测试结果
  4. 如有问题,描述问题返回代码生成步骤修改

快速开始

根据 {方案路径} 方案测试相应功能是否实现。

通用操作

模型选择

  1. 点击状态栏的 模型:xxx ▾
  2. 在弹出的对话框中选择模型
  3. 选择后自动保存为默认模型

文件选择

  1. 在输入框输入 @
  2. 弹出文件选择器
  3. 选择文件后路径自动填入

命令快捷输入

  1. 点击状态栏的 "命令"
  2. 输入常用命令
  3. 命令自动填入输入框

停止生成

如果 AI 生成时间过长或不需要继续:

  1. 点击 "■ 停止" 按钮
  2. AI 会在当前步骤完成后停止

目录结构

每个需求项目会生成以下结构:

{大类}/
└── {需求名}/
    ├── {需求名}_方案.md    # 方案文档
    └── session.json       # 会话 ID 配置

session.json 示例

{
  "designSessionId": "xxx-design-id",
  "codeSessionId": "xxx-code-id",
  "testSessionId": "xxx-test-id"
}

最佳实践

方案设计

  1. 明确业务目标:先描述要解决的问题
  2. 细化功能点:列出具体的功能需求
  3. 考虑边界情况:异常处理、数据校验
  4. 多次迭代:与 AI 多轮讨论完善方案

代码生成

  1. 方案先行:确保方案完整再生成代码
  2. 分步生成:大功能拆分成小功能逐步生成
  3. 边生成边测试:不要等全部完成再测试

测试验收

  1. 功能测试:验证功能是否按方案实现
  2. 边界测试:测试异常输入
  3. 回归测试:确保修改没有破坏已有功能

常见问题

Q: 如何切换需求项目?
A: 在左侧边栏点击不同的大类或需求名称。

Q: 三个会话有什么区别?
A: design 会话用于方案设计,code 会话用于代码生成,test 会话用于测试。各自独立,不会互相干扰。

Q: 方案文档保存在哪里?
A: 保存在 {大类}/{需求名}/{需求名}_方案.md

Q: 如何重新开始一个需求?
A: 在大类中新建需求,系统会创建全新的目录和会话。