feat(skills): 两包资源索引机制与双向对账脚本
- product-planning:新建 references/manifest.md 作资源唯一登记处(资源/落点/引用点/口径); 顶层 SKILL 加两条硬规矩,design-capture、stage-delivery、execution-runbook、stage-requirements 四处把散落路径改为「落点见 references/manifest.md」 - session-mechanism:01-文档索引 新增 §四「包内资源索引」,并说明不放 manifest.md 的理由 (那份由 install.py 本机生成、被 .gitignore 挡着) - 新增两包共用的 scripts/check_resource_index.py(双向对账)与 product-planning/scripts/check_figures.py(图片机检), selftest 补对应用例,06-技能优化规程 写入写法规矩 - .gitignore:新增 _留痕/ 不入库(改造前整包快照,180K/688K,库内从无先例)
This commit is contained in:
1 parent
a9d2adaf72
commit
acfb252bee
14 files changed
+626
-39
No files matched your search
@@ -227,6 +227,8 @@ DESIGN.md 说明:`@google/design.md` 提供 `lint` / `diff` / `export` / `spec
|
||||
- 禁止长文:单份产出物默认一页纸(≤120 行),超长必须拆分。
|
||||
- ⭐ 落盘产出的排版(2026-10-14 用户令,原话「标题周围写小字的怪毛病 彻底改掉」):元信息(条数、口径、读法、状态)写进表格的列、条目的字段或表头;标题旁边、标题下面、标题后面都只放标题本身。④段的 `references/doc-language-spec.md` 另有一份更细的,冲突以那份为准。
|
||||
- 🔴 路径写相对或占位(2026-10-14 用户令):本包内一切文字(`SKILL.md`、`references/**`、脚本与注释、模板)引用**本技能自己或同根技能**的位置时,写相对形态 —— 同根技能写 `<技能根>/<技能名>/`,本包自己的文件写包内相对路径(如 `references/stage-delivery/`)。只有**跨根引用**(工作区根、文档库根、本机软件安装位这类从本包推不出来的别的根)才落到具体位置,且优先读环境变量(`DSH_WS_ROOT` / `DSH_DOCS_ROOT` / `WORKBUDDY_BIN_ROOT`)。原因:技能根的位置随环境变(全局技能根还是工作区技能根、用户名与盘符各不相同),写死了换台机器就是死路径,跨环境会整片报错。
|
||||
- 🔴 **资源路径只在资源清单写一次(2026-10-16 用户令)**:本包有什么资源、落在哪、被谁引用,**唯一登记处**是 `references/manifest.md` 的「资源索引」表;别的文字里**只写资源名**(如「样式套目录」「工具箱·design-capture」),⛔ 不把路径抄进散文、段文档、脚本注释与模板。理由(用户原话:「为什么这么多地方引用一个样式库,是不是技能中没有统一索引机制」):路径一抄成 N 处,改一次目录就要改 N 个地方,**漏一处还不报错**。清单里标 `只写一次` 的资源,其路径字面量只许出现在清单本身与清单 `许可字面量` 列登记的文件里。
|
||||
- 🔴 **改完本包跑一次资源索引对账**(同一道令):`python "<技能根>/session-mechanism/scripts/check_resource_index.py" --pkg "<本包根>"`(两个技能包共用这一份实现)。它报四类:落点不存在 / 登记的引用点不是真的 / 有人绕开清单在别处写了路径字面量 / 登记了却没人用的资源。⛔ 有 🔴 不算改完,不静默放过。
|
||||
|
||||
## 征询外部模型(GPT)的提问口径(单一真源)
|
||||
|
||||
@@ -247,11 +249,16 @@ DESIGN.md 说明:`@google/design.md` 提供 `lint` / `diff` / `export` / `spec
|
||||
- 图要**表达结构或流程**(二选一或兼具)—— 一张图看完就知道「由哪几块组成、怎么连起来」或「一件事分几步走」;⛔ 不做纯装饰性配图。
|
||||
- 图表达这份文档**覆盖的东西之间的关系**,按段定画什么:
|
||||
· ①段(`research/` 五份)—— 画对象与流向:为谁解决什么、信息从哪来到哪去。
|
||||
· ②段(文档根 `产品规划/prd/` 两份)—— 画页面骨架:有哪几页、每页几个板块、跨页关系怎么走。
|
||||
· ①段 `research/1b-独立分析/<竞品名>.md` —— 每个候选一份,图要画该候选管哪个环节、缺哪个环节(通常是「环节覆盖条」)。
|
||||
· ②段 `prd/2a-产品功能.md` —— 画**功能归组**:功能组有几组、每组覆盖哪几段、各多少条(页面此时还没定,⛔ 不画页面骨架)。
|
||||
· ②段 `prd/2b-界面布局.md` —— 画**页面骨架**:有哪几页、每页几个板块、跨页关系怎么走。
|
||||
· ③段(`ui/` 下的产物与 `DESIGN.md`)—— 画页面结构与操作动线:用户办成一件事实际经过哪几页、每页做什么、哪里要来回跳。
|
||||
· ④段(产品文档)—— 画页面结构图(各页面与其下的功能编号)+ 用户路径:各场景怎么串起来。
|
||||
· 跨段 `专题/` —— 按该篇讲什么定:讲方法画方法的分层或步骤,讲盘点画对比矩阵,讲落地画数据流或结构。
|
||||
- **一份文档一张自己的图**:图要对着这份文档的内容画,⛔ 不借用兄弟文档的图(借用必然出现「图说别的、文说这个」)。
|
||||
- 画图用 `diagram-design`,⛔ 不手写 Mermaid(判据见「工具选择规则」那张表)。
|
||||
- 图里每格写清名字、线标方向;图与正文互相对得上 —— 正文新增或改了结构,图要跟着改,两处不许各说各的。
|
||||
- **收口跑机检**:`python scripts/check_figures.py --ws <工作区或产品根>`。它逐份扫 `产品规划/` 下除 `归档-过期版/` 的 md,判定三件事:开头 8 行内有 ``、引用的图文件在位、同一张图没有被两份文档共用。报 FAIL 就不算收口。
|
||||
|
||||
## 每段的标准收尾格式
|
||||
|
||||
|
||||
Reference in new issue
Block a user