使用说明文档

1

使用说明文档

aicr 项目使用说明文档

1. 项目简介

aicr (AI Code Review) 是一个基于人工智能的代码审查系统，旨在通过 AI 技术辅助开发团队进行代码审查、架构守护和需求分析，提高代码质量和开发效率。

系统主要功能包括：

  • 代码审查：自动检测代码中的潜在问题和缺陷
  • 架构守护：确保代码符合架构设计规范
  • 需求分析：自动分析需求文档，生成结构化需求
  • 审计报告：生成详细的审查报告和统计数据

2. 系统功能

2.1 前端功能模块

模块名称 功能描述 访问路径
登录系统 用户登录和认证 /login
项目管理 创建、查看和管理项目 /projects
审计报告 查看代码审查和架构守护报告 /auditReport
需求管理 导入、分析和管理需求 /requirement
审查规则 配置功能点审查和架构守护规则 /reviewRules
规则模板 管理审查规则模板 /template
平台配置 系统级配置和用户管理 /platform

2.2 核心功能详解

2.2.1 项目管理

  • 创建新项目：设置项目名称、描述等基本信息
  • 查看项目列表：浏览所有已创建的项目
  • 项目详情：查看项目的审计报告和需求分析结果

2.2.2 需求管理

  • 导入需求：从外部系统导入需求文档
  • 需求分析：使用 AI 自动分析需求，生成结构化需求
  • 需求版本管理：跟踪需求的变更历史
  • 重新分析：对需求进行重新分析，更新结构化需求

2.2.3 代码审查

  • 功能点审查：检测代码中的功能实现问题
  • 架构守护：检测代码是否符合架构设计规范
  • 审查报告：生成详细的审查报告，包含问题描述和建议
  • 重新审查：对代码进行重新审查，更新审查结果

2.2.4 规则管理

  • 功能点审查规则：配置功能点审查的规则和标准
  • 架构守护规则：配置架构守护的规则和标准
  • 架构分层配置：配置系统的架构分层结构
  • 规则模板：管理和应用规则模板

3. 使用流程

3.1 系统登录

  1. 访问系统

    • 打开浏览器，输入前端应用地址（由系统管理员提供）
    • 按下 Enter 键，进入登录页面

  2. 登录操作

    • 在登录页面的用户名输入框中，输入您的用户名
    • 在密码输入框中，输入您的密码
    • 点击「登录」按钮，提交登录信息
    • 系统验证成功后，自动跳转到系统首页

3.2 项目管理流程

3.2.1 创建项目

  1. 进入项目管理页面

    • 登录系统后，从左侧导航菜单中点击「项目管理」或直接访问 /projects 路径

  2. 启动创建项目流程

    • 在项目管理页面的右上角，点击「创建项目」按钮
    • 系统会弹出创建项目对话框

  3. 填写项目信息

    • 在「项目名称」输入框中，输入项目的名称（必填）
    • 在「项目描述」文本框中，输入项目的详细描述（可选）
    • 选择项目的所属团队或部门（如果系统支持）
    • 设置项目的其他属性（如负责人、截止日期等）

  4. 完成创建

    • 点击对话框底部的「确定」按钮，提交项目信息
    • 系统会提示创建成功，并自动刷新项目列表
    • 新创建的项目会显示在项目列表中

3.2.2 查看项目列表

  1. 浏览项目

    • 在项目管理页面，您可以看到所有已创建的项目卡片
    • 每个项目卡片显示项目名称、描述、创建时间等基本信息

  2. 搜索项目

    • 在页面右上角的搜索框中，输入项目名称或关键词
    • 系统会实时过滤显示匹配的项目
    • 点击搜索框右侧的「清空」按钮，可以清除搜索条件

  3. 进入项目详情

    • 点击任意项目卡片，系统会跳转到该项目的审计报告页面
    • 在审计报告页面，您可以查看项目的详细信息和审查结果

3.2.3 管理项目

  1. 编辑项目

    • 在项目卡片上，点击「编辑」按钮
    • 修改项目信息后，点击「保存」按钮

  2. 删除项目

    • 在项目卡片上，点击「删除」按钮
    • 在弹出的确认对话框中，点击「确定」按钮
    • 系统会删除该项目及其相关数据

3.3 需求管理流程

3.3.1 导入需求

  1. 进入需求管理页面

    • 从左侧导航菜单中点击「需求管理」或直接访问 /requirement 路径

  2. 启动导入流程

    • 在需求管理页面的顶部，点击「导入」按钮
    • 系统会弹出导入需求对话框

  3. 选择导入方式

    • 选择「文件导入」：点击「浏览」按钮，选择本地的需求文档文件
    • 选择「外部系统导入」：从下拉菜单中选择外部系统，输入相关参数

  4. 确认导入

    • 点击「确定」按钮，开始导入需求
    • 系统会显示导入进度和结果
    • 导入成功后，需求会显示在需求列表中

3.3.2 需求分析

  1. 查看分析状态

    • 在需求列表中，每个需求项都显示分析状态（理解中、成功、失败）
    • 状态为「理解中」表示系统正在分析需求
    • 状态为「成功」表示需求分析完成
    • 状态为「失败」表示需求分析遇到问题

  2. 查看分析结果

    • 状态为「成功」的需求，点击「结构化需求」按钮
    • 系统会弹出对话框，显示生成的结构化需求
    • 结构化需求包含功能点、输入输出、业务规则等详细信息

  3. 重新分析需求

    • 在需求列表中，找到需要重新分析的需求
    • 点击「重新分析」按钮
    • 系统会重新开始分析该需求
    • 分析完成后，状态会更新，结构化需求会重新生成

3.3.3 管理需求版本

  1. 查看需求版本

    • 在需求列表中，每个需求项都显示需求版本号
    • 版本号格式为 V1、V2、V3 等

  2. 查看版本历史

    • 点击需求项的「版本历史」按钮
    • 系统会显示该需求的所有版本记录
    • 可以查看每个版本的创建时间、更新内容等信息

  3. 回滚版本

    • 在版本历史中，选择要回滚的版本
    • 点击「回滚到此版本」按钮
    • 系统会将需求恢复到选定的版本状态

3.4 代码审查流程

3.4.1 查看审计报告

  1. 进入审计报告页面

    • 从左侧导航菜单中点击「审计报告」或直接访问 /auditReport 路径
    • 或通过项目管理页面点击项目卡片进入

  2. 选择项目和迭代

    • 在页面左侧的项目树中，选择要查看的项目
    • 在项目下选择要查看的迭代
    • 右侧表格会显示该迭代的所有审查记录

  3. 过滤审查结果

    • 使用页面顶部的筛选条件：

      • 关键字搜索：输入任务/需求/提交内容关键字
      • 功能点审查状态：选择审查状态（全部、审查中、成功、失败、需求待澄清）
      • 架构守护审查状态：选择审查状态（全部、审查中、成功、失败）
      • 提交人：输入提交人姓名
      • 审核人：输入审核人姓名

    • 点击「重置」按钮，可以清除所有筛选条件

  4. 查看审查记录

    • 在表格中，每条记录显示任务名称、需求名称、审查状态、提交内容描述等信息
    • 可以点击表格头部的列名，对记录进行排序
    • 可以调整每页显示的记录数量

3.4.2 查看报告详情

  1. 查看任务详情

    • 在审查记录表格中，找到要查看的记录
    • 点击「任务详情」按钮
    • 系统会弹出对话框，显示任务的详细信息

  2. 查看审查报告

    • 在审查记录表格中，找到要查看的记录
    • 点击「报告详情」按钮
    • 系统会弹出对话框，显示详细的审查报告
    • 审查报告包含问题描述、严重程度、建议解决方案等信息
    • 对于代码问题，会显示相关代码片段

  3. 查看问题详情

    • 在审查记录表格中，点击记录左侧的展开图标
    • 系统会展开显示该记录的所有问题详情
    • 可以查看每个问题的描述、位置、建议等信息

  4. 使用评审助手

    • 在审查报告对话框中，点击页面中的机器人图标或「打开评审助手」按钮
    • 系统会在右侧或底部打开评审助手面板
    • 评审助手会自动提供报告解读或相关建议
    • 可以在评审助手中输入自定义问题，获取更详细的分析
    • 可以选择预设命令，如「全文报告解读」、「问题报告解读」等
    • 评审助手会基于报告内容提供智能分析和建议

  5. 功能点审查报告评审助手

    • 标题：功能点评审
    • 默认命令：全文报告解读
    • 功能：解读功能点审查报告，提供问题分析和解决方案建议
    • 交互方式：通过聊天界面与 AI 助手交流，获取详细分析

  6. 架构守护审查报告评审助手

    • 标题：架构守护评审
    • 默认命令：全文报告解读
    • 功能：解读架构守护审查报告，分析架构问题和改进建议
    • 交互方式：通过聊天界面与 AI 助手交流，获取详细分析

3.4.3 重新审查

  1. 选择审查类型

    • 在审查记录表格中，找到需要重新审查的记录

    • 点击「重新审查」按钮，会显示下拉菜单

    • 从下拉菜单中选择审查类型：

      • 全部：同时进行功能点审查和架构守护审查
      • 功能点：只进行功能点审查
      • 架构守护：只进行架构守护审查

  2. 确认重新审查

    • 系统会弹出确认对话框，显示要进行的审查类型
    • 点击「确定」按钮，开始重新审查
    • 系统会显示审查进度

  3. 查看审查结果

    • 审查完成后，系统会自动更新审查状态
    • 可以点击「报告详情」按钮，查看更新后的审查报告
    • 可以点击「任务详情」按钮，查看任务的最新状态

3.5 规则管理流程

3.5.1 配置功能点审查规则

  1. 进入审查规则页面

    • 从左侧导航菜单中点击「审查规则」或直接访问 /reviewRules 路径

  2. 选择规则类型

    • 在审查规则页面的左侧，点击「功能点审查规则」选项

  3. 创建规则

    • 点击页面右上角的「创建规则」按钮
    • 系统会弹出创建规则对话框
    • 填写规则名称、描述、严重程度等信息
    • 配置规则的具体内容和检测逻辑
    • 点击「保存」按钮，完成规则创建

  4. 编辑规则

    • 在规则列表中，找到要编辑的规则
    • 点击「编辑」按钮
    • 修改规则信息后，点击「保存」按钮

  5. 删除规则

    • 在规则列表中，找到要删除的规则
    • 点击「删除」按钮
    • 在弹出的确认对话框中，点击「确定」按钮

3.5.2 配置架构守护规则

  1. 选择规则类型

    • 在审查规则页面的左侧，点击「架构守护规则」选项

  2. 创建规则

    • 点击页面右上角的「创建规则」按钮
    • 系统会弹出创建规则对话框
    • 填写规则名称、描述、严重程度等信息
    • 配置规则的具体内容和检测逻辑
    • 点击「保存」按钮，完成规则创建

  3. 管理规则

    • 编辑规则：点击规则的「编辑」按钮，修改规则信息
    • 删除规则：点击规则的「删除」按钮，删除规则
    • 启用/禁用规则：点击规则的「启用」/「禁用」按钮，切换规则状态

3.5.3 配置架构分层

  1. 选择配置类型

    • 在审查规则页面的左侧，点击「架构分层配置」选项

  2. 配置分层结构

    • 点击「添加分层」按钮，添加新的架构层
    • 输入层名称、描述、优先级等信息
    • 配置层与层之间的依赖关系
    • 点击「保存」按钮，完成配置

  3. 管理分层

    • 编辑分层：点击分层的「编辑」按钮，修改分层信息
    • 删除分层：点击分层的「删除」按钮，删除分层
    • 调整优先级：通过拖拽，调整分层的优先级顺序

3.5.4 管理规则模板

  1. 进入规则模板页面

    • 从左侧导航菜单中点击「规则模板」或直接访问 /template 路径

  2. 创建模板

    • 点击页面右上角的「创建模板」按钮
    • 系统会弹出创建模板对话框
    • 填写模板名称、描述等信息
    • 选择要包含在模板中的规则
    • 点击「保存」按钮，完成模板创建

  3. 应用模板

    • 在模板列表中，找到要应用的模板
    • 点击「应用」按钮
    • 选择要应用模板的项目或系统
    • 点击「确定」按钮，完成模板应用

  4. 管理模板

    • 编辑模板：点击模板的「编辑」按钮，修改模板信息
    • 删除模板：点击模板的「删除」按钮，删除模板
    • 查看模板详情：点击模板的「详情」按钮，查看模板包含的规则

4. 常见操作指南

4.1 如何查看代码审查结果？

  1. 进入审计报告页面

    • 登录系统后，从左侧导航菜单中点击「审计报告」

  2. 选择项目和迭代

    • 在左侧项目树中，展开项目节点
    • 选择要查看的迭代

  3. 筛选结果

    • 使用顶部的筛选条件，如功能点审查状态、架构守护审查状态等
    • 输入关键字，搜索特定的审查记录

  4. 查看详细报告

    • 在表格中找到要查看的记录
    • 点击「报告详情」按钮
    • 在弹出的对话框中，查看详细的审查报告
    • 可以查看问题描述、建议和相关代码片段

  5. 查看问题列表

    • 点击记录左侧的展开图标
    • 查看该记录的所有问题详情
    • 可以按严重程度、类型等排序问题

4.2 如何使用评审助手？

  1. 进入审查报告页面

    • 登录系统后，从左侧导航菜单中点击「审计报告」
    • 找到要查看的审查记录，点击「报告详情」按钮

  2. 打开评审助手

    • 在审查报告对话框中，点击页面中的机器人图标或「打开评审助手」按钮
    • 系统会在右侧或底部打开评审助手面板

  3. 使用功能点审查报告评审助手

    • 在「功能点审查报告」标签页中，评审助手会自动加载
    • 默认命令：全文报告解读
    • 可以选择预设命令，如「报告解读」、「全文报告解读」等
    • 可以在输入框中输入自定义问题，如「这个问题的具体原因是什么？」、「如何修复这个问题？」等
    • 评审助手会基于报告内容提供智能分析和解决方案建议

  4. 使用架构守护审查报告评审助手

    • 在「架构守护审查报告」标签页中，评审助手会自动加载
    • 默认命令：全文报告解读
    • 可以选择预设命令，如「问题报告解读」等
    • 可以在输入框中输入自定义问题，如「这个架构问题的影响是什么？」、「如何优化这个架构设计？」等
    • 评审助手会基于报告内容提供架构分析和改进建议

  5. 交互技巧

    • 清晰描述问题：使用具体的问题描述，获得更准确的回答
    • 引用具体问题：可以在问题中引用报告中的具体问题编号或描述
    • 追问细节：如果对助手的回答不满意，可以继续追问，获得更详细的信息
    • 保存重要信息：对于有价值的建议，可以复制保存，用于后续的代码改进

4.3 如何导入和分析需求？

  1. 进入需求管理页面

    • 登录系统后，从左侧导航菜单中点击「需求管理」

  2. 导入需求

    • 点击页面顶部的「导入」按钮
    • 选择要导入的需求文件
    • 点击「确定」按钮，开始导入

  3. 查看分析状态

    • 导入完成后，系统会自动开始分析需求
    • 在需求列表中，查看需求的分析状态
    • 状态为「理解中」表示正在分析
    • 状态为「成功」表示分析完成
    • 状态为「失败」表示分析遇到问题

  4. 查看结构化需求

    • 对于分析成功的需求，点击「结构化需求」按钮
    • 在弹出的对话框中，查看系统生成的结构化需求
    • 结构化需求包含功能点、输入输出、业务规则等信息

  5. 重新分析需求

    • 如果对分析结果不满意，点击「重新分析」按钮
    • 系统会重新分析需求，并更新结构化需求

4.4 如何配置架构守护规则？

  1. 进入审查规则页面

    • 登录系统后，从左侧导航菜单中点击「审查规则」

  2. 选择架构守护规则

    • 在左侧菜单中，点击「架构守护规则」选项

  3. 创建新规则

    • 点击页面右上角的「创建规则」按钮
    • 填写规则名称：输入规则的名称
    • 填写规则描述：输入规则的详细描述
    • 设置严重程度：选择规则的严重程度（低、中、高）
    • 配置规则逻辑：根据系统提供的选项，配置规则的检测逻辑

  4. 保存规则

    • 点击「保存」按钮，完成规则创建
    • 新创建的规则会显示在规则列表中

  5. 管理现有规则

    • 编辑规则：点击规则的「编辑」按钮，修改规则信息
    • 删除规则：点击规则的「删除」按钮，删除规则
    • 启用/禁用规则：点击规则的状态开关，启用或禁用规则

4.5 如何重新审查代码？

  1. 进入审计报告页面

    • 登录系统后，从左侧导航菜单中点击「审计报告」

  2. 找到要重新审查的记录

    • 在表格中，找到需要重新审查的审查记录
    • 确认记录的当前状态和信息

  3. 选择审查类型

    • 点击记录右侧的「重新审查」按钮

    • 从下拉菜单中选择审查类型：

      • 全部：同时进行功能点审查和架构守护审查
      • 功能点：只进行功能点审查
      • 架构守护：只进行架构守护审查

  4. 确认重新审查

    • 系统会弹出确认对话框，显示要进行的审查类型
    • 点击「确定」按钮，开始重新审查
    • 系统会显示审查进度条

  5. 查看审查结果

    • 审查完成后，系统会自动更新审查状态
    • 点击「报告详情」按钮，查看更新后的审查报告
    • 查看问题是否已解决，或是否有新的问题发现

4.6 如何使用规则模板？

  1. 进入规则模板页面

    • 登录系统后，从左侧导航菜单中点击「规则模板」

  2. 创建模板

    • 点击页面右上角的「创建模板」按钮
    • 填写模板名称和描述
    • 从规则列表中，选择要包含在模板中的规则
    • 点击「保存」按钮，完成模板创建

  3. 应用模板

    • 在模板列表中，找到要应用的模板
    • 点击「应用」按钮
    • 在弹出的对话框中，选择要应用模板的项目
    • 点击「确定」按钮，完成模板应用

  4. 管理模板

    • 编辑模板：点击模板的「编辑」按钮，修改模板信息
    • 删除模板：点击模板的「删除」按钮，删除模板
    • 查看模板详情：点击模板的「详情」按钮，查看模板包含的规则

5. 故障排除

5.1 前端常见问题

问题 可能原因 解决方案
无法登录系统 用户名或密码错误 检查用户名和密码是否正确，确认 Caps Lock 是否关闭
页面加载缓慢 网络连接问题 检查网络连接，刷新页面，或尝试使用其他浏览器
操作无响应 系统繁忙 等待一段时间后重试，或刷新页面
页面显示异常 浏览器兼容性问题 使用 Chrome、Firefox、Safari 或 Edge 等现代浏览器
功能按钮不可用 权限不足或条件不满足 检查用户权限，确认操作条件是否满足

5.2 需求分析常见问题

问题 可能原因 解决方案
需求分析失败 需求文档格式不正确 检查需求文档格式，确保文档清晰可读，避免使用特殊格式
结构化需求不完整 需求描述不详细 提供更详细的需求描述，包含必要的功能点、输入输出、业务规则等信息
需求分析超时 需求文档过大或复杂 拆分大型需求文档，简化需求描述，或增加分析时间限制
导入需求失败 文件格式不支持 确认需求文件格式是否支持（如 .doc、.docx、.md 等）

5.3 代码审查常见问题

问题 可能原因 解决方案
审查任务失败 代码分析超时 检查代码复杂度，优化代码结构，或增加分析时间限制
审查结果不准确 规则配置不当 调整规则配置，优化规则逻辑，或增加规则的准确性
审查速度慢 代码量过大 拆分代码审查任务，分批进行审查，或优化系统性能
架构守护失败 架构分层配置不当 检查架构分层配置，确保分层结构合理，依赖关系正确

文档版本：1.2.0

更新日期：2026-02-02