@routerhub/agent-rules 1.5.165 → 1.5.167
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.base.md +6 -4
- package/package.json +1 -1
- package/rules/global.md +6 -4
- package/skills/create-doc/SKILL.md +34 -15
- package/skills/visual-report/SKILL.md +1 -1
package/AGENTS.base.md
CHANGED
|
@@ -390,6 +390,7 @@
|
|
|
390
390
|
|
|
391
391
|
### HTML 文档截图与 curl 命令规范
|
|
392
392
|
|
|
393
|
+
- ⚠️ **HTML 页面/文档中的外部链接默认用新标签页打开**：所有指向外部资源（其他网站、GitHub 文档、私有仓库 PDF 等）的链接一律写成 `<a target="_blank" rel="noopener" href="...">`，禁止不加 `target` 让用户点击后直接跳出当前页面。**类比：逛商场拿着一份导购地图，每个店名都标着「在新窗口查看」——点一家店不会把你从地图里踢出去，地图还在，能连续逛好几家；不新开窗口的话，每点一家店整张地图就没了，得反复按返回。** `rel="noopener"` 是安全兜底，防止新页面通过 `window.opener` 反向控制当前页（tabnabbing 钓鱼攻击）。
|
|
393
394
|
- ⚠️ **截图版 HTML 文档中的截图必须自动加箭头标注**：当用户要求写「截图版 HTML」文档（以截图为主体、图文结合说明实现/操作步骤的文档，如部署实现说明、操作指南等）时，嵌入的每张截图都必须自动用醒目的箭头 + 简短文字标签标注出关键区域/验证点/操作位置，让读者一眼看懂这张图对应文档的哪一步、证明了什么，禁止只贴裸图不标注。箭头标注放在不遮挡原内容的位置。
|
|
394
395
|
- ⚠️ **HTML 文档中的截图必须以 `data:image/png;base64,...` 内嵌，禁止用文件路径或相对链接引用外部 PNG 文件。** 文档会被打开、移动、分享，外部图片路径一旦脱离原目录就全部失效，文档里全是裂图。生成文档后，散落的零散 PNG 文件应一并清理，只保留 HTML 本身。
|
|
395
396
|
- ⚠️ **curl 命令必须完整可复制执行，禁止省略关键参数。** 包括但不限于：API Key / Token、请求体中的图片数据、完整的 URL。禁止用 `...` 或「省略其余参数」代替——看的人无法区分「这里不重要所以省略了」还是「这里我不会写所以跳过了」，前者让命令不可执行，后者掩盖了潜在的错误。
|
|
@@ -518,10 +519,11 @@
|
|
|
518
519
|
|
|
519
520
|
## 文档规则
|
|
520
521
|
|
|
521
|
-
- ⚠️
|
|
522
|
-
- ⚠️
|
|
523
|
-
-
|
|
524
|
-
-
|
|
522
|
+
- ⚠️ **文档格式选型：能 MD 就 MD，HTML→PDF 只用于截图版报告**：需求说明、操作指南、设计文档、接口文档等纯文字/表格类文档一律用 Markdown 直接写（GitHub 原生渲染、零转换步骤）；只有验证报告/截图版报告等需要内嵌截图+箭头标注的可视化文档才用 HTML→PDF（GitHub blob 视图对 HTML 显示源码不渲染，转 PDF 才能点开即看）。**类比：写便签能说清的事就不要做成一整本画册——便签（MD）贴上墙人人直接看，画册（HTML）GitHub 这面墙只显示印刷源码，还得额外转成 PDF 才能翻。** 判断标准：文档需要「截图为主、文字为辅」吗？需要 → HTML→PDF；不需要 → MD 直传。
|
|
523
|
+
- ⚠️ **代码仓库的 `docs/` 目录只维护一个索引文件 `docs/index.html`**（`文档名 | 链接` 表格，链接一律 `target="_blank" rel="noopener"` 新标签页打开），**禁止在 `docs/` 存放文档正文**（HTML / PDF / MD / 截图 / 图片等大文件一律不提交进代码仓库）。
|
|
524
|
+
- ⚠️ **文档正文存放到本项目对应的私有 GitHub 仓库 `<项目>-docs`**（如 `PomexAITeam/pomexai-docs`），仓库名由 git remote 推导：`git@github.com:PomexAITeam/pomexai.git` → 组织 `PomexAITeam`、项目 `pomexai` → 文档仓库 `PomexAITeam/pomexai-docs`。**私有仓库 = 仅团队成员登录后可查看**，天然满足「文档只给团队看」。
|
|
525
|
+
- 新建文档使用 `/create-doc` skill：纯文字/表格类 → 直接写 MD 直传；截图版报告 → 生成 HTML → 无头 Chrome 转 PDF → push 到 `<项目>-docs` 私有仓库的 `docs` 分支 → 在代码仓库 `docs/index.html` 记录「文档名 | 链接」。
|
|
526
|
+
- 文档链接格式：`https://github.com/<ORG>/<项目>-docs/blob/docs/<文件名>.<pdf|md>`，粘贴到浏览器即可查看（GitHub 内嵌渲染 PDF / Markdown；私有仓库未登录会跳登录页）。
|
|
525
527
|
|
|
526
528
|
## 文档/文件链接交付
|
|
527
529
|
|
package/package.json
CHANGED
package/rules/global.md
CHANGED
|
@@ -390,6 +390,7 @@ name: "通用规则"
|
|
|
390
390
|
|
|
391
391
|
### HTML 文档截图与 curl 命令规范
|
|
392
392
|
|
|
393
|
+
- ⚠️ **HTML 页面/文档中的外部链接默认用新标签页打开**：所有指向外部资源（其他网站、GitHub 文档、私有仓库 PDF 等）的链接一律写成 `<a target="_blank" rel="noopener" href="...">`，禁止不加 `target` 让用户点击后直接跳出当前页面。**类比：逛商场拿着一份导购地图，每个店名都标着「在新窗口查看」——点一家店不会把你从地图里踢出去，地图还在，能连续逛好几家；不新开窗口的话，每点一家店整张地图就没了，得反复按返回。** `rel="noopener"` 是安全兜底，防止新页面通过 `window.opener` 反向控制当前页（tabnabbing 钓鱼攻击）。
|
|
393
394
|
- ⚠️ **截图版 HTML 文档中的截图必须自动加箭头标注**：当用户要求写「截图版 HTML」文档（以截图为主体、图文结合说明实现/操作步骤的文档，如部署实现说明、操作指南等）时，嵌入的每张截图都必须自动用醒目的箭头 + 简短文字标签标注出关键区域/验证点/操作位置，让读者一眼看懂这张图对应文档的哪一步、证明了什么，禁止只贴裸图不标注。箭头标注放在不遮挡原内容的位置。
|
|
394
395
|
- ⚠️ **HTML 文档中的截图必须以 `data:image/png;base64,...` 内嵌，禁止用文件路径或相对链接引用外部 PNG 文件。** 文档会被打开、移动、分享，外部图片路径一旦脱离原目录就全部失效，文档里全是裂图。生成文档后，散落的零散 PNG 文件应一并清理，只保留 HTML 本身。
|
|
395
396
|
- ⚠️ **curl 命令必须完整可复制执行，禁止省略关键参数。** 包括但不限于：API Key / Token、请求体中的图片数据、完整的 URL。禁止用 `...` 或「省略其余参数」代替——看的人无法区分「这里不重要所以省略了」还是「这里我不会写所以跳过了」，前者让命令不可执行，后者掩盖了潜在的错误。
|
|
@@ -518,10 +519,11 @@ name: "通用规则"
|
|
|
518
519
|
|
|
519
520
|
## 文档规则
|
|
520
521
|
|
|
521
|
-
- ⚠️
|
|
522
|
-
- ⚠️
|
|
523
|
-
-
|
|
524
|
-
-
|
|
522
|
+
- ⚠️ **文档格式选型：能 MD 就 MD，HTML→PDF 只用于截图版报告**：需求说明、操作指南、设计文档、接口文档等纯文字/表格类文档一律用 Markdown 直接写（GitHub 原生渲染、零转换步骤）；只有验证报告/截图版报告等需要内嵌截图+箭头标注的可视化文档才用 HTML→PDF（GitHub blob 视图对 HTML 显示源码不渲染，转 PDF 才能点开即看）。**类比：写便签能说清的事就不要做成一整本画册——便签（MD）贴上墙人人直接看，画册（HTML）GitHub 这面墙只显示印刷源码，还得额外转成 PDF 才能翻。** 判断标准：文档需要「截图为主、文字为辅」吗？需要 → HTML→PDF；不需要 → MD 直传。
|
|
523
|
+
- ⚠️ **代码仓库的 `docs/` 目录只维护一个索引文件 `docs/index.html`**（`文档名 | 链接` 表格，链接一律 `target="_blank" rel="noopener"` 新标签页打开），**禁止在 `docs/` 存放文档正文**（HTML / PDF / MD / 截图 / 图片等大文件一律不提交进代码仓库）。
|
|
524
|
+
- ⚠️ **文档正文存放到本项目对应的私有 GitHub 仓库 `<项目>-docs`**（如 `PomexAITeam/pomexai-docs`），仓库名由 git remote 推导：`git@github.com:PomexAITeam/pomexai.git` → 组织 `PomexAITeam`、项目 `pomexai` → 文档仓库 `PomexAITeam/pomexai-docs`。**私有仓库 = 仅团队成员登录后可查看**，天然满足「文档只给团队看」。
|
|
525
|
+
- 新建文档使用 `/create-doc` skill：纯文字/表格类 → 直接写 MD 直传；截图版报告 → 生成 HTML → 无头 Chrome 转 PDF → push 到 `<项目>-docs` 私有仓库的 `docs` 分支 → 在代码仓库 `docs/index.html` 记录「文档名 | 链接」。
|
|
526
|
+
- 文档链接格式：`https://github.com/<ORG>/<项目>-docs/blob/docs/<文件名>.<pdf|md>`，粘贴到浏览器即可查看（GitHub 内嵌渲染 PDF / Markdown；私有仓库未登录会跳登录页）。
|
|
525
527
|
|
|
526
528
|
## 文档/文件链接交付
|
|
527
529
|
|
|
@@ -11,22 +11,35 @@ description: >-
|
|
|
11
11
|
「生成一个截图版的html」「生成截图版html」「生成一个截图版」「生成截图版」「截图版文档」「截图版报告」「截图版说明」「截图版的」等任何「截图版」表述。
|
|
12
12
|
「生成一个html」「生成html」「生成一个html文档」「生成html文档」「写个html」「写html」「做一个html」「做个html」「出一个html」「出个html」「搞个html」「整个html」「弄个html」「html文档」「html报告」等任何明确要求生成 HTML 的表述。
|
|
13
13
|
「html」单独说且上下文在讨论产出物时也应触发。
|
|
14
|
-
|
|
14
|
+
自动生成符合项目规范的中文文档，存入本项目私有文档仓库（<项目>-docs），在代码仓库 docs/index.html 索引记录「文档名 | 链接」。纯文字/表格类文档用 Markdown 直传（GitHub 原生渲染、零转换）；截图版报告用 HTML 格式（中文文件名、base64 内嵌截图、lightbox 放大、截图为主文字为辅）转 PDF 后上传。
|
|
15
15
|
---
|
|
16
16
|
|
|
17
|
-
# 创建文档（HTML
|
|
17
|
+
# 创建文档（MD 直传 / HTML→PDF → 私有文档仓库）
|
|
18
18
|
|
|
19
|
-
⚠️ **本 Skill 已触发。第一句话必须输出：「🔧 已触发 `create-doc`，按规范生成文档（HTML→PDF→私有仓库）」然后严格按照以下步骤执行，不得跳过。**
|
|
19
|
+
⚠️ **本 Skill 已触发。第一句话必须输出：「🔧 已触发 `create-doc`，按规范生成文档（MD 直传或 HTML→PDF→私有仓库）」然后严格按照以下步骤执行，不得跳过。**
|
|
20
20
|
|
|
21
|
-
生成符合项目规范的中文文档/报告。最终交付形式是
|
|
21
|
+
生成符合项目规范的中文文档/报告。最终交付形式是 **私有文档仓库链接**（GitHub 内嵌渲染 PDF / Markdown，私有仓库仅团队成员登录可见）；代码仓库 `docs/` 只保留索引 `docs/index.html`，不存放文档正文。
|
|
22
|
+
|
|
23
|
+
## 第一步：格式选型（能 MD 就 MD）
|
|
24
|
+
|
|
25
|
+
- ⚠️ **判断这份文档是否需要「截图为主、文字为辅」**：
|
|
26
|
+
- **纯文字/表格类**（需求说明、操作指南、设计文档、接口文档、方案总结等）→ **MD 直传**：直接写 `.md` 文件，GitHub 原生渲染，零转换步骤。走下方「MD 直传」流程。
|
|
27
|
+
- **截图版报告**（验证报告、需要内嵌截图+箭头标注的可视化文档）→ **HTML→PDF**：走下方「HTML 转 PDF」流程。GitHub blob 视图对 HTML 显示源码不渲染，必须转 PDF 才能点开即看。
|
|
28
|
+
- 用户明确要求「生成 html / 截图版」的，直接走 HTML→PDF，不必再问格式。
|
|
22
29
|
|
|
23
30
|
## 交付流程总览
|
|
24
31
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
32
|
+
- **MD 直传路径**：
|
|
33
|
+
1. 直接写 `.md` 文档（中文文件名）
|
|
34
|
+
2. push MD 到本项目对应的私有文档仓库 `<项目>-docs` 的 `docs` 分支
|
|
35
|
+
3. 在代码仓库 `docs/index.html` 索引记录「文档名 | 链接」
|
|
36
|
+
4. 交付给用户：`https://github.com/<ORG>/<项目>-docs/blob/docs/<文件名>.md` 链接 + 一行内容说明
|
|
37
|
+
- **HTML→PDF 路径**：
|
|
38
|
+
1. 按下方「文档规范」生成 HTML 文档（**中间产物**，中文文件名）
|
|
39
|
+
2. 用无头 Chrome 将 HTML 转成 PDF
|
|
40
|
+
3. push PDF 到本项目对应的私有文档仓库 `<项目>-docs` 的 `docs` 分支
|
|
41
|
+
4. 在代码仓库 `docs/index.html` 索引记录「文档名 | 链接」
|
|
42
|
+
5. 交付给用户：`https://github.com/<ORG>/<项目>-docs/blob/docs/<文件名>.pdf` 链接 + 一行内容说明
|
|
30
43
|
|
|
31
44
|
## 确定文档仓库（从 git remote 推导）
|
|
32
45
|
|
|
@@ -39,6 +52,13 @@ description: >-
|
|
|
39
52
|
```
|
|
40
53
|
- remote 无法推导（非 `github.com:<ORG>/<REPO>` 形态）时，询问用户项目标识。
|
|
41
54
|
|
|
55
|
+
## MD 直传
|
|
56
|
+
|
|
57
|
+
- 纯文字/表格类文档（格式选型判断为 MD 的）：直接写 `.md` 文件，**跳过 HTML 生成与 PDF 转换**，直传私有文档仓库。
|
|
58
|
+
- 交付文件名：中文命名（如 `模型分时段定价需求文档.md`）。
|
|
59
|
+
- 上传方式与「push 到文档仓库」章节一致（clone → docs 分支 → 放入 MD → commit → push）。
|
|
60
|
+
- ⚠️ MD 中需要展示截图/图片的，用相对路径引用并同时上传图片到 `assets/` 目录（或按 GitHub Markdown 内嵌方式处理），禁止引用外部链接。
|
|
61
|
+
|
|
42
62
|
## HTML 转 PDF
|
|
43
63
|
|
|
44
64
|
- HTML 生成后存到本地临时目录（如 `screenshots/` 同级或 `/tmp`），用无头 Chrome 转换：
|
|
@@ -71,14 +91,13 @@ description: >-
|
|
|
71
91
|
- PDF 文件名：`<日期>-<文档中文名>.pdf`（如 `2026-08-31-模型模块化补测验证报告.pdf`），**每次新增独立文件，禁止覆盖旧文档**。
|
|
72
92
|
- 若 remote 不是 `git@github.com:...` 形态，用实际 remote URL 替换 clone 地址。
|
|
73
93
|
|
|
74
|
-
## 记录索引（代码仓库 docs/
|
|
94
|
+
## 记录索引（代码仓库 docs/index.html）
|
|
75
95
|
|
|
76
|
-
- 更新代码仓库 `docs/
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
|--------|------|
|
|
80
|
-
| <文档名> | https://github.com/PomexAITeam/pomexai-docs/blob/docs/<文件名>.pdf |
|
|
96
|
+
- 更新代码仓库 `docs/index.html`（HTML 表格索引，链接一律 `target="_blank" rel="noopener"` 新标签页打开），按现有 index.html 结构在表格追加一行「文档名 | 链接」，示例：
|
|
97
|
+
```html
|
|
98
|
+
<tr><td class="doc">文档名</td><td class="link"><a target="_blank" rel="noopener" href="https://github.com/PomexAITeam/pomexai-docs/blob/docs/<文件名>.pdf">文件名.pdf<span class="badge pdf">PDF</span></a></td></tr>
|
|
81
99
|
```
|
|
100
|
+
- ⚠️ `docs/index.html` 是新标签页打开链接的 HTML 索引；GitHub 上点开会显示源码，下载后双击即可在浏览器查看渲染效果。
|
|
82
101
|
- 索引随代码正常提交（feature 分支 → PR），这是代码仓库 `docs/` 里唯一的内容。
|
|
83
102
|
|
|
84
103
|
## 交付给用户
|
|
@@ -47,7 +47,7 @@ description: >-
|
|
|
47
47
|
|
|
48
48
|
## 报告格式（交付物 = 可视化报告 PDF 链接）
|
|
49
49
|
|
|
50
|
-
- ⚠️ 用 `/create-doc` skill 生成可视化报告并交付为 **PDF 链接**：`/create-doc` 会生成 HTML（中间产物）→ 转 PDF → push 到本项目私有文档仓库 `<项目>-docs` 的 `docs` 分支 → 在代码仓库 `docs/
|
|
50
|
+
- ⚠️ 用 `/create-doc` skill 生成可视化报告并交付为 **PDF 链接**：`/create-doc` 会生成 HTML（中间产物）→ 转 PDF → push 到本项目私有文档仓库 `<项目>-docs` 的 `docs` 分支 → 在代码仓库 `docs/index.html` 索引记录「文档名 | 链接」。交付给用户的是一行可点击的 GitHub 链接（`https://github.com/<ORG>/<项目>-docs/blob/docs/<文件名>.pdf`），不是本地 HTML 文件。
|
|
51
51
|
- ⚠️ 代码仓库 `docs/` 只维护索引，禁止把报告正文（HTML/PDF/截图）直接放进 `docs/`。
|
|
52
52
|
- **报告骨架**（每个验证点必须有）：
|
|
53
53
|
1. **结论卡**：本次改动改了什么、验证结果是对是错、用户确认没有
|