--- name: ticket-management description: 用 Gitea 工单库做「人读 + 机读」双面管理,并**始终维护工单的结构有效性与整洁性**。**动工单(新建或更新)前先做结构评估**:把本轮信息按「问题背景 / 处置提案 / 处置结果 / 效果对比」四段**任务全貌**出「落点表」,再过「只记要点」四问闸门(改不了全貌的不进工单);正文 = 现行唯一权威叙事,评论只留必须可执行物,外部来源只进末尾机读引用块。含 bin/ticket.mjs 的 labels/milestones/list/verify/assess/create/update/comments/comment-add/comment-del/rename。适用于:建单、更新工单正文或评论、整理精简既有工单、校验工单是否合规、用 API 读写 Gitea issue。 --- # ticket-management(Gitea 工单管理) > **定位**:执行方法(怎么做),不含项目结论。 > **一句话**:**动工单前先评结构 · 只把改变「任务全貌」的要点写进去 · 正文是唯一权威叙事 · 每次改完都自检「有效性 + 整洁性」**。 ## 0 什么时候用 / 不用 **用**:新建工单;**更新**工单(标题 / 正文 / 评论);整理或精简既有工单;校验工单是否合规;用 API 读标签 / 里程碑 / 工单。 **不用**:拿工单做排期与资源计划(那是项目管理);把工作区内部知识库路径写进工单(见 §1 规则 3)。 ## 1 硬规则(不合规就不建单 / 不改单) > **动工单(新建或更新)前必过两条前置闸门** —— 它们是本技能的**第一动作**,不能事后补: > - **闸门 A · 先评结构**(§8.0):先出**落点表**(本轮每条信息落在**正文哪一段 / 评论 / 外部**),再落笔。**没有落点表,不许改工单。** > - **闸门 B · 只记要点**(§8.2):每条候选信息过**四问** —— **改变不了「任务全貌」的,一律不进工单**(工单不是日志)。 > > **改完必过第三条**:**§8.3 自检 + `verify`(§7)全过**,才算改完(见规则 4)。 1. **标签零新增 · 且建单必传** —— 只用仓库既有标签;**不得**为分类新建标签(标签是给人扫的稀缺资源,词表一膨胀人就不再用了);**建单 `--label=` 为必传参数**,缺失或 id 无效 ⇒ 工具**拒建**(实测 `#156`/`#157` 因未传而裸建无标签,用户 2026-09-23 纠正)。 1b. **问题与解决方案一律落工单 · 但落点只有一个**(用户 2026-09-23 交办,**2026-09-24 修订**):凡与**问题**或**解决方案**相关的产出(现象 / 根因 / 证据 / 方案与选项 / 执行窗口与风险 / 回退 / 验收),都必须**有工单落点**;但**落点 = 该单的「问题正文」**(见 §8 结构纪律),**不是评论流水**。文档可以详写,工单只写**现行叙事 + 证据指针**(指针进末尾引用块),且单号与外部记录号互指。 1c. **工单 = 干净时间线(rebase 模型 · 2026-09-24 立 · 用户交办)**:「工单能溯源」指的是**类似 git 的 `rebase`**——**不是** `merge`,**不是**把每个变更都堆上去。要求:**该删删、该合并合并**,只留能读懂的**问题 → 行动 → 现状 → 判据**。**执行细则见 §8。** 2. **标题 = `【问题域】`**(当前**不能开工**时,把闸门**并进同一个括号**写成 `【域-闸门】`,分隔符是**半角连字符 `-`**;**不要写两个括号**)—— 闸门**只在「当前不能开工」时**出现;能开工就不加(默认即常态,零打扰)。 3. **正文自包含** —— 人读部分**不得**出现工作区 / 本地路径(`codes/`、`分析/`、`C:\…`、`/home/…`)或内部分析编号;源码引用一律 **仓库相对路径 + 该 ref 的 permalink**。 4. **结构有效性与整洁性是可交付条件** —— 每次编辑后**必须**跑 §8.3 自检与 `verify`(§7)并**全过**;**结构坏了就不算改完**(宁可先不改)。 ## 2 标题规范 - **前缀(必填,单括号、`-` 分隔)**:`【订单】` `【库存】` `【结算】` `【商品】` `【报表】` `【平台】` `【其他】`;带闸门时**合并成一个括号**:`【域-闸门】`(例 `【报表-等口径】`)—— 分隔符用**半角连字符 `-`**;**不要写两个括号**(`【报表】【等口径】` 已废止)。 - 词表**可按项目替换**,但**改动须登记**;新域先用 `【其他】`,**同域攒够 3 条再立**新前缀。 - **闸门(可选)**:`-等口径` `-等取证` `-等部署` —— **仅当「不能开工」**;可开工 ⇒ 括号里只有域。 - **准入三问**(新增任何段都要过):① 列表页会按它筛 / 排吗?② 能否从正文推出(能推就别重复占位)?③ 生命周期里会变几次(反复变 = 每次都要改标题)? - 按此三问:**问题域、闸门**通过;**优先级**(churn 大)· **端** · **环境** · **版本** · **客户 / 店铺**(敏感)· **批次**(用 milestone)全部不通过。 ## 3 正文规范 ### 3.1 首行 = 机读行(也是人读的第一行) 域=L1-L2-L3 | 闸门=… | 优先级=… | 类型=… | 模式=… | 端=… | 环境=… | 证据=… - **字段顺序固定**;分隔符 = 空格 + 竖线 + 空格。 - **`域` 的 L1 必须等于标题主前缀**(机器可校验);`域` 三段逐级更细、**用半角连字符 `-` 分隔**(`域=L1-L2-L3`,如 `域=报表-统计-模式分列`):**L1 受控**(= 标题词表)· **L2 受控小词表** · **L3 自由**(表 / 文件 / 函数 / 接口)。 - 枚举建议:`闸门`=可开工|等口径|等取证|等部署 · `优先级`=立即|本迭代|排队 · `类型`=安全|数据|性能|可用|债务 · `端`=后端|前端|小程序|运维 · `环境`=正式服|测服 · `证据`=E1|E2|需生产取证。 - 若标题出现闸门段,**必须与 `闸门=` 一致**。 ### 3.2 正文其余(人读)= 「任务全貌」四段 ## 问题背景 现象 · 影响面 · 根因(含证据锚点)· 复现 ## 处置提案 打算怎么做 / 已选路线 / 为什么;执行窗口与风险;回退 ## 处置结果 实际做了什么 · 当前状态 ← 未发生就整段不写 ## 效果对比 改前 vs 改后:指标 + 口径 + 时点 ← 未测就整段不写 (可选补段)## 验收判据 / ## 反证条件 / ## 遗留 - **段序固定**(背景 → 提案 → 结果 → 效果);**未发生的段不写空壳**(宁缺不空);**判据 / 反证 / 遗留**放四段之后。 - 证据锚点 = 仓库相对路径:行 + permalink(§4)。**取舍与粒度见 §8.1 / §8.2。** ### 3.3 末尾 = 机读引用块(人读渲染不可见) ```html ``` - **必须**写明 `ref-owner`(**引用对象的拥有者**)—— 读者据此知道该去哪儿找、以及**它不在这条工单所在的仓里**。 - **没有外部引用就整段不要**;也不要把内部编号写进人读部分。 ## 4 路径口径 | | 写法 | |---|---| | ✅ 源码(本仓) | `path/to/file.go:105` + `https://///src/commit//#L105` | | ✅ 依赖 / 框架(**另一个仓**) | 另标仓:`https://///src/tag//#L829` | | ⛔ 禁用 | 本地物化前缀(`codes/` · `vendor/` 副本)、工作区路径(`分析/`)、内部分析编号 | ⚠ **行号必须按所引 ref 复核** —— 本地克隆常落后远端(实测:本地 `f5b74b2` 落后远端 `main` `c210c293`)。做法:用 API 取该 ref 的文件内容,再在内容里定位行号。 ## 5 工具 `bin/ticket.mjs` ```bash # 令牌:GITEA_TOKEN 环境变量,或 --token-file=<含 key=value 的文件>(不落盘、不回显) node bin/ticket.mjs labels --repo=xbc/xbc node bin/ticket.mjs milestones --repo=xbc/xbc node bin/ticket.mjs list --repo=xbc/xbc --state=open node bin/ticket.mjs verify 142 --repo=xbc/xbc # 七项断言 node bin/ticket.mjs assess 142 --repo=xbc/xbc # 结构评估(落点表底稿) node bin/ticket.mjs assess --body-file=body.md # 只评正文(无需令牌) node bin/ticket.mjs create --repo=xbc/xbc --title='【平台】…' --body-file=body.md --label=77 [--dry-run] node bin/ticket.mjs update 142 --repo=xbc/xbc --body-file=body.md [--title='【平台】…'] [--dry-run] node bin/ticket.mjs comments 142 --repo=xbc/xbc [--dump=_备份.md] # 清单 / 删前备份 node bin/ticket.mjs comment-add 142 --repo=xbc/xbc --body-file=cmt.md [--dry-run] node bin/ticket.mjs comment-del 12345 --repo=xbc/xbc [--yes] # 不带 --yes 只预览 node bin/ticket.mjs rename 142 --repo=xbc/xbc --domain=平台 [--gate=等口径] [--dry-run] ``` | 子命令 | 作用 | 需要 scope | |---|---|---| | `labels` / `milestones` / `list` | 读(标签 id 是创建时唯一可传的形式) | `read:issue` | | `verify ` | **校验**(只读):见 §7 七项断言(含标签非空) | `read:issue` | | `assess ` / `assess --body-file=f` | **结构评估**(只读):四段现状 / 缺段 / 空壳段 + 评论清单 ⇒ §8.0 落点表底稿 | `read:issue` | | `create` | 建单(**先按标题查重**;**`--label` 必传**,缺失 / id 不存在 ⇒ 拒建) | `write:issue` | | `update ` | 改正文(**标题与正文同一次 PATCH**,§8.1 第 4 条);过自检,不过 ⇒ 拒改 | `write:issue` | | `comments ` | 评论清单(id / 字数 / 首行);`--dump=f` = 全量备份(**删前必做**) | `read:issue` | | `comment-add ` | 加评论(只放**必须可执行物**,§8.1 第 2 条) | `write:issue` | | `comment-del ` | 删评论(**默认只预览**;`--yes` 才删 ⇒ 与 `--dump` 备份配套) | `write:issue` | | `rename ` | 规范化标题(重建前缀,描述不动) | `write:issue` | ## 6 常见坑(实测) - **HTTP 分块解码**:`let d = ''; res.on('data', c => d += c)` 会把**跨块的多字节字符**打成 `U+FFFD`(中文标签名就被打坏过)⇒ 必须 `res.setEncoding('utf8')`,或用 `fetch` 的 `text()`。 - **建单前必须查重**:按标题查,否则会重复建单。 - **标签传 id**:`POST /issues` 的 `labels` 是**标签 id 数组**,不是名字。 - **批量改首行时必须保持 ` | ` 形态**(空格 + 竖线 + 空格):把 `域=…` 换成新值时若顺手吃掉它后面的空格,`闸门=` 会与 `域` 黏成一段 ⇒ **断言 4 全线 FAIL**(实测 14/14 中招,工具拦住了)。 - **改标题与正文**:都是 `PATCH /repos/{owner}/{repo}/issues/{n}`;**要同一次提交**(用 `update`,见 §8.1 第 4 条)。 - **令牌 scope**:只读 `read:issue,read:repository` 建不了单(403,报错会写 required scope);建 / 改需 `write:issue`;`GET /user` 另需 `read:user`。 - **里程碑可能已被当「状态桶」用**(如「记录工单 / 领取工单 / 完结工单」)⇒ 不要再用它承载闸门,否则两套状态打架;用前先 `milestones` 看语义与 `due_on`。 - **没有看板时**(`/projects` 返回 404)不要设计「用看板列承载闸门」的流程。 ## 7 `verify` 的七项断言(可交机器) 1. 标题以 `【…】` 开头,且内文 ∈ 问题域词表; 2. 正文第一行存在且含 `域=`; 3. **标题主域 = 首行 `域=` 的 L1**(`域` 内以 `-` 分层); 4. 标题 `-` 后的闸门 ∈ 词表 **且** 等于首行 `闸门=`;**可开工时标题不得带 `-闸门`**(多写即 FAIL); 5. 人读部分(第一个 `