快速开始

开始之前#

第 1 步：连接项目#

在首页点击“进入工作台”。根据你的登录方式，第一屏会不同：

• 已用 GitHub 登录：显示“选择要维护的项目”。从“我的仓库”或“我有权访问的仓库”中选择，或切换到“粘贴仓库地址”，然后点击“连接”。列表按最近更新排序，每页最多 30 个，搜索只作用于当前页。
• 未用 GitHub 登录：直接打开“项目体检”的新任务。在第 2 步填写仓库地址并开始体检，该仓库会同时成为当前项目。

连接只保存当前项目，不会自动体检、调用模型或发布内容。之后可以点击侧栏顶部的项目名称随时切换项目。

完成后：侧栏顶部显示项目名称。

第 2 步：完成第一次体检#

1. 进入侧栏“项目体检”，填写或核对 GitHub 仓库地址。分支留空时使用仓库的默认分支，需要时可以填写其他分支。
2. 查看表单下方的模式提示：
   • 显示“基础规则模式”表示没有可用模型，本次只做规则检查；
   • 已配置默认模型时，会额外进行内容研判。
3. 点击“发送仓库，开始体检”。任务依次经过 读取仓库 → 收集文件 → 规范检查 → 内容研判 → 生成报告 五个阶段，左侧执行轨迹会实时更新。
4. 完成后点击“打开完整报告”。

完成后：你会得到一份包含 8 项规则检查（启用模型时另有 3 项内容研判）的报告。

第 3 步：读懂体检报告#

报告顶部是检查结果构成，下方是“维护检查清单”。

1. 先用状态筛选查看 待完善 的检查项，每一项都有结论、来源文件和改进建议。
2. 展开“规则检查依据”或“内容研判依据”，核对引用的文件路径和原文片段。
3. 再看 无法判断 的项目：它表示证据不足（例如子项目结构复杂），不等于有问题，也不等于通过。
4. 需要留存时，导出 Markdown 或 JSON 报告，文件名包含仓库名和提交短 SHA。

第 4 步：生成第一份草稿#

这一步需要默认模型。

1. 在报告页点击“生成改进草稿”，或进入“草稿与交付”，在“从体检问题生成文档改进”中选择一个待完善项。
2. 生成完成后打开草稿，在 编辑 / 预览 / 差异 之间切换，核对来源证据和目标文件。
3. 删去模型猜测的内容（不存在的命令、地址或功能），修改后点击“保存”。

完成后：草稿以“待审阅”状态保存在项目中，可以继续编辑或下载。生成和保存都不会写回 GitHub。

下一步#

• 理解快照、证据和确认机制：核心概念
• 处理协作队列：Issue 分诊、PR 检查
• 把草稿发布到 GitHub：草稿与交付 · 确认交付
• 首次真实发布前，建议先确认发布目标与仓库权限，再在测试仓库试一次。