@microi.net/cli 4.6.2

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.
Files changed (112) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +66 -0
  3. package/dist/mcp-codex-stdio-adapter.js +189 -0
  4. package/dist/mcp-server.js +972 -0
  5. package/dist/mcp-trae-windows-launcher.cmd +21 -0
  6. package/dist/microi-cli-mcp.js +7 -0
  7. package/dist/microi-cli.js +1645 -0
  8. package/dist/microi-skills.meta.json +335 -0
  9. package/dist/microi.skills/.microi-skills-version.json +6 -0
  10. package/dist/microi.skills/README.md +276 -0
  11. package/dist/microi.skills/ai-engine/SKILL.md +140 -0
  12. package/dist/microi.skills/ai-engine/agents/openai.yaml +4 -0
  13. package/dist/microi.skills/app-store/SKILL.md +105 -0
  14. package/dist/microi.skills/app-store/agents/openai.yaml +4 -0
  15. package/dist/microi.skills/business-blueprint/SKILL.md +184 -0
  16. package/dist/microi.skills/datasource-engine/SKILL.md +89 -0
  17. package/dist/microi.skills/datasource-engine/agents/openai.yaml +4 -0
  18. package/dist/microi.skills/dos-orm/SKILL.md +76 -0
  19. package/dist/microi.skills/dos-orm/references/api-reference.md +229 -0
  20. package/dist/microi.skills/job-engine/SKILL.md +141 -0
  21. package/dist/microi.skills/job-engine/agents/openai.yaml +4 -0
  22. package/dist/microi.skills/message-notification/SKILL.md +113 -0
  23. package/dist/microi.skills/message-notification/agents/openai.yaml +6 -0
  24. package/dist/microi.skills/message-notification/references/contracts.md +99 -0
  25. package/dist/microi.skills/microi-ai-app-auth.js +651 -0
  26. package/dist/microi.skills/microi-ai-application/SKILL.md +80 -0
  27. package/dist/microi.skills/microi-ai-application/agents/openai.yaml +4 -0
  28. package/dist/microi.skills/microi-ai-application/references/frontend-baseline.md +164 -0
  29. package/dist/microi.skills/microi-client-frontend/SKILL.md +562 -0
  30. package/dist/microi.skills/microi-datasource-mapping/SKILL.md +108 -0
  31. package/dist/microi.skills/microi-db-schema/SKILL.md +170 -0
  32. package/dist/microi.skills/microi-db-schema/agents/openai.yaml +4 -0
  33. package/dist/microi.skills/microi-db-schema/references/core-tables.md +695 -0
  34. package/dist/microi.skills/microi-db-schema/references/form-component-options.md +256 -0
  35. package/dist/microi.skills/microi-db-schema/references/schema-overview.md +203 -0
  36. package/dist/microi.skills/microi-db-schema/references/schema.md +647 -0
  37. package/dist/microi.skills/microi-db-schema/references/table-catalog.md +1607 -0
  38. package/dist/microi.skills/microi-deployment/SKILL.md +117 -0
  39. package/dist/microi.skills/microi-deployment/references/deployment-matrix.md +94 -0
  40. package/dist/microi.skills/microi-docs-coverage/SKILL.md +91 -0
  41. package/dist/microi.skills/microi-docs-coverage/references/capability-map.md +65 -0
  42. package/dist/microi.skills/microi-docs-coverage/scripts/audit-doc-skill-coverage.mjs +887 -0
  43. package/dist/microi.skills/microi-form-engine/SKILL.md +159 -0
  44. package/dist/microi.skills/microi-form-engine/references/component-catalog.md +116 -0
  45. package/dist/microi.skills/microi-form-engine/references/data-source-events.md +117 -0
  46. package/dist/microi.skills/microi-form-layout/SKILL.md +373 -0
  47. package/dist/microi.skills/microi-frontend-sdk/SKILL.md +304 -0
  48. package/dist/microi.skills/microi-left-right-layout/SKILL.md +132 -0
  49. package/dist/microi.skills/microi-microservice/SKILL.md +115 -0
  50. package/dist/microi.skills/microi-microservice/references/runtime-delivery.md +145 -0
  51. package/dist/microi.skills/microi-mobile-app-quality/SKILL.md +436 -0
  52. package/dist/microi.skills/microi-solution-quotation/SKILL.md +76 -0
  53. package/dist/microi.skills/microi-solution-quotation/agents/openai.yaml +4 -0
  54. package/dist/microi.skills/microi-solution-quotation/scripts/build_solution_quote.py +296 -0
  55. package/dist/microi.skills/microi-system-delivery/SKILL.md +446 -0
  56. package/dist/microi.skills/microi-ui/SKILL.md +321 -0
  57. package/dist/microi.skills/microi-uniapp-frontend/SKILL.md +483 -0
  58. package/dist/microi.skills/microi.v8.js +1758 -0
  59. package/dist/microi.skills/module-engine/SKILL.md +131 -0
  60. package/dist/microi.skills/module-engine/references/module-config.md +174 -0
  61. package/dist/microi.skills/page-engine/SKILL.md +397 -0
  62. package/dist/microi.skills/performance-testing/SKILL.md +207 -0
  63. package/dist/microi.skills/playwright-e2e/SKILL.md +769 -0
  64. package/dist/microi.skills/print-engine/SKILL.md +237 -0
  65. package/dist/microi.skills/production-readonly-audit/SKILL.md +39 -0
  66. package/dist/microi.skills/report-engine/SKILL.md +69 -0
  67. package/dist/microi.skills/report-engine/agents/openai.yaml +4 -0
  68. package/dist/microi.skills/search-engine/SKILL.md +73 -0
  69. package/dist/microi.skills/search-engine/agents/openai.yaml +4 -0
  70. package/dist/microi.skills/spider-engine/SKILL.md +188 -0
  71. package/dist/microi.skills/translate-engine/SKILL.md +91 -0
  72. package/dist/microi.skills/translate-engine/agents/openai.yaml +4 -0
  73. package/dist/microi.skills/ui-design/SKILL.md +1575 -0
  74. package/dist/microi.skills/ui-design/assets/pattern-showcase/app.js +54 -0
  75. package/dist/microi.skills/ui-design/assets/pattern-showcase/index.html +163 -0
  76. package/dist/microi.skills/ui-design/assets/pattern-showcase/styles.css +311 -0
  77. package/dist/microi.skills/ui-design/assets/templates/MCI-DESIGN.md +98 -0
  78. package/dist/microi.skills/ui-design/references/design-pattern-library.md +171 -0
  79. package/dist/microi.skills/ui-design/references/mci-design-contract.md +84 -0
  80. package/dist/microi.skills/ui-design/references/motion-and-media.md +71 -0
  81. package/dist/microi.skills/ui-design/references/product-flow-recipes.md +94 -0
  82. package/dist/microi.skills/uniapp-mall-assets/SKILL.md +105 -0
  83. package/dist/microi.skills/v8-api-config/SKILL.md +272 -0
  84. package/dist/microi.skills/v8-cache-pattern/SKILL.md +286 -0
  85. package/dist/microi.skills/v8-crud-api/SKILL.md +398 -0
  86. package/dist/microi.skills/v8-debugging/SKILL.md +279 -0
  87. package/dist/microi.skills/v8-explorer-tree/SKILL.md +224 -0
  88. package/dist/microi.skills/v8-export-import/SKILL.md +590 -0
  89. package/dist/microi.skills/v8-file-upload/SKILL.md +497 -0
  90. package/dist/microi.skills/v8-formengine-http/SKILL.md +218 -0
  91. package/dist/microi.skills/v8-frontend-events/SKILL.md +349 -0
  92. package/dist/microi.skills/v8-frontend-events/references/bluetooth-print-api.md +107 -0
  93. package/dist/microi.skills/v8-frontend-events/references/bluetooth-print.md +185 -0
  94. package/dist/microi.skills/v8-http-integration/SKILL.md +379 -0
  95. package/dist/microi.skills/v8-image-processing/SKILL.md +187 -0
  96. package/dist/microi.skills/v8-image-processing/agents/openai.yaml +4 -0
  97. package/dist/microi.skills/v8-image-processing/references/api-reference.md +620 -0
  98. package/dist/microi.skills/v8-menu-buttons/SKILL.md +661 -0
  99. package/dist/microi.skills/v8-mongodb/SKILL.md +149 -0
  100. package/dist/microi.skills/v8-mq-mqtt/SKILL.md +227 -0
  101. package/dist/microi.skills/v8-saas-multi-tenant/SKILL.md +193 -0
  102. package/dist/microi.skills/v8-security/SKILL.md +417 -0
  103. package/dist/microi.skills/v8-sql-query/SKILL.md +290 -0
  104. package/dist/microi.skills/v8-table-event/SKILL.md +385 -0
  105. package/dist/microi.skills/v8-template-engine/SKILL.md +165 -0
  106. package/dist/microi.skills/v8-utilities/SKILL.md +79 -0
  107. package/dist/microi.skills/v8-utilities/references/client-api-index.md +136 -0
  108. package/dist/microi.skills/v8-utilities/references/platform-http-routes.md +80 -0
  109. package/dist/microi.skills/v8-utilities/references/server-api-index.md +129 -0
  110. package/dist/microi.skills/v8-workflow/SKILL.md +322 -0
  111. package/dist/microi.skills/workspace-conventions/SKILL.md +479 -0
  112. package/package.json +40 -0
@@ -0,0 +1,117 @@
1
+ ---
2
+ name: microi-deployment
3
+ description: Microi 安装、部署、升级和本地运行指南。用于 Docker Compose、离线安装、Windows IIS、源码运行、MySQL、Redis、MongoDB、MinIO、反向代理、滚动发布、健康检查、备份恢复和生产部署验收。
4
+ ---
5
+
6
+ # Microi 安装与部署
7
+
8
+ 本 Skill 把官网 Docker、Windows 和源码运行文档转成可执行的安全流程。具体镜像、
9
+ 版本、端口和命令可能变化,执行前必须回读当前中文官网、仓库 compose/配置和目标
10
+ 主机状态,不能把旧示例当作当前生产事实。
11
+
12
+ ## 必读参考
13
+
14
+ - 部署方式、依赖、配置和验收矩阵:`references/deployment-matrix.md`
15
+ - 系统级交付与 MCP:`../microi-system-delivery/SKILL.md`
16
+ - 文件/对象存储:`../v8-file-upload/SKILL.md`
17
+ - 数据库模型:`../microi-db-schema/SKILL.md`
18
+
19
+ ## 先确认部署类型
20
+
21
+ | 场景 | 推荐入口 |
22
+ |---|---|
23
+ | 生产 Linux、快速安装、可滚动升级 | Docker/Compose |
24
+ | 无互联网环境 | 在联网机制作离线包,再在目标机校验并安装 |
25
+ | Windows 传统环境 | IIS + .NET Hosting Bundle + 独立依赖 |
26
+ | 开发/调试 | 后端源码 + 前端 Vite,本地依赖或隔离容器 |
27
+
28
+ 不得在未确认目标主机、目录、数据卷和备份的情况下执行官网“删除所有容器/编排”
29
+ 或任何递归删除命令。
30
+
31
+ ## 变更前只读盘点
32
+
33
+ 至少记录:
34
+
35
+ - 操作系统、CPU、物理内存、可用磁盘、时区与端口占用;
36
+ - 当前 API/Web/Worker 节点数、镜像/版本、反向代理与证书;
37
+ - MySQL、Redis、MongoDB、MinIO/HDFS 地址和持久卷;
38
+ - 当前 `OsClient`、数据库备份、对象存储备份和配置备份;
39
+ - JWT/AuthSecret 等集群共享密钥的指纹一致性,绝不输出明文;
40
+ - `/api/Diagnostics/health` readiness 与 `/api/Diagnostics/liveness`;
41
+ - 当前运行中的 Node、dotnet、Docker build 等重任务。
42
+
43
+ ## 多节点与滚动发布
44
+
45
+ 后端默认按多个 API/Worker 节点设计:
46
+
47
+ - 所有节点共享业务数据库、MongoDB、Redis 和持久对象存储。
48
+ - 全局状态、任务进度、锁和幂等事实不能只放进程内存/本机文件。
49
+ - 新旧版本并存期间使用“先扩展、后迁移、再收缩”的兼容顺序。
50
+ - 节点先停止接新工作,再有界排空;readiness 退出流量,liveness 只反映进程存活。
51
+ - 数据库迁移、建索引、种子和缓存预热必须幂等,多节点同时启动不能重复副作用。
52
+ - AuthSecret 在全部节点保持一致;轮换必须有明确的全节点策略,否则现有 JWT 会失效。
53
+
54
+ ## 构建资源保护
55
+
56
+ 启动 Node/Vite/dotnet/Docker build 前检查物理内存和同类进程。默认只运行一个重任务,
57
+ 为 VS Code、Codex 和操作系统保留至少 `max(6GB, 物理内存 20%)`。资源不足时改做
58
+ 定向测试/构建,不并行启动多个全量任务;全机占用达到 95% 时终止本轮启动的重任务树。
59
+
60
+ ## Windows 多 AI 本地服务与 Release 文件锁
61
+
62
+ 多个 AI 对话共用同一工作区和固定 `61500/61501` 时,前后端是工作区级单例共享服务,
63
+ 不是每个对话各自拥有的后台进程。发布必须使用“工作区互斥 + 精确身份识别 + DLL 锁复核”:
64
+
65
+ - 健康开发服务默认复用;需要重载源码时串行重启。长期后端只从项目目录执行
66
+ `dotnet run --launch-profile Microi.net.Api`,禁止直接运行 `bin/Release/net10.0`
67
+ 或 `bin/Release/publish` 作为 E2E 服务。
68
+ - 一键发布在改写输出目录前创建 `.tmp/microi-process-state/release.lock`;锁存在时其它 AI
69
+ 不得启动、自愈或重启 `61500/61501`。
70
+ - Windows 发布前调用 `Microi.Server/tools/Microi.LocalProcessManager.ps1 -Action PrepareRelease`。
71
+ 只在端口、命令行和当前工作区路径同时匹配时停止 Microi API/Vite,并额外查找当前工作区
72
+ 的 Release API;身份不匹配时失败关闭,禁止使用 `/IM dotnet.exe`、`/IM node.exe`、
73
+ `/IM chrome.exe` 或 `/IM msedge.exe` 全机清理。
74
+ - 停止后必须确认 `61500/61501` 已释放,并以 `FileShare.None` 独占打开
75
+ `Microi.net.Api/bin/Release/net10.0` DLL。只结束 `VBCSCompiler` 不能解决正在运行的
76
+ `.NET Host` 对业务 DLL 的锁定。
77
+ - Edge/Chrome 用户浏览器、VS Code 的 Playwright Test Server、MCP/语言服务 Node、
78
+ 数据库和 Redis 不属于发布清理范围。人工查看使用进程管理器的 `-Action Status`。
79
+
80
+ ## 一键发布产物边界与缓存
81
+
82
+ - 需要完整解决方案构建和 NuGet 打包时,先完成一次 Release build;publish 阶段复用已验证产物,禁止先 clean 再重复编译同一项目引用链。
83
+ - API 镜像只允许使用 `bin/Release/publish`,前端镜像只允许使用 `bin/Release/dist` 和必要的服务器配置;`net10.0`、源码、测试输出及其它构建中间目录不得进入 Docker 上下文。
84
+ - `logs`、故障 spool、WAL 和节点诊断文件属于运行态数据。发布前后及冒烟测试后都要从 publish 清理,但不得删除源码/持久卷中尚待重放的原始 spool;项目文件应从源头设置为不复制到发布目录。
85
+ - 正式发布不需要 PDB 时,从 publish 清单统一排除项目引用和第三方 PDB,并在推送前断言数量为零;这不等于删除编译中间目录中用于本地诊断的符号。
86
+ - Docker 使用内容摘要缓存并在基础镜像标签可变时检查更新;不要在每个镜像方案前无条件 `prune -a` 或永久使用 `--no-cache`。磁盘不足时先报告占用,再对精确目标做可恢复或有条件清理。
87
+ - DLL 混淆/签名必须先于最终冒烟测试,确保被验证、写入 NuGet 和放入 Docker 的是同一份最终 DLL。前端旧浏览器产物可以按源码、转换器和依赖锁文件的内容指纹做增量缓存,但缓存命中后仍需执行完整依赖、polyfill 和入口校验。
88
+
89
+ ## 部署证据分层
90
+
91
+ 不要把某一层成功等同生产完成:
92
+
93
+ 1. 配置/compose 静态检查。
94
+ 2. 镜像拉取或定向构建成功。
95
+ 3. 容器/进程启动且无启动错误。
96
+ 4. liveness/readiness 正常,依赖可达。
97
+ 5. 登录、菜单、FormEngine、ApiEngine、文件上传等真实路径正常。
98
+ 6. 双节点重复投递、节点退出、滚动升级与恢复验证。
99
+
100
+ 未执行的层必须明确写“未验证”,不能用“部署成功”概括。
101
+
102
+ ### 复盘:启动文案变化导致一键发布冒烟假失败
103
+
104
+ - 触发场景:发布产物已经输出 `Now listening` / `Application started` 并可访问,但发布脚本因为等待某句历史中文启动文案而持续到超时,期间运行态日志或 spool 不断写入 `publish/logs`。
105
+ - 根因:把易变化的日志文本当成服务可用事实源;超时/异常路径没有对临时进程和运行态目录做完整的有界收尾。
106
+ - 通用规则:发布冒烟必须启动最终混淆/签名后的产物,确认本次进程仍存活,再以 `/api/Diagnostics/liveness` HTTP 200 判定启动成功;使用专用空闲端口,成功、超时、异常和中断路径都要在有限时间内结束本次进程并清理 publish 内的临时 logs/PDB。版本号已经更新但尚未提交时,重跑默认继续工作区当前版本,不能再次自动递增;当前版本进入 Git HEAD 后才计算下一版本。
107
+ - 自动化检查:构造不再输出旧中文文案但 liveness 返回 200 的版本,断言冒烟成功;另覆盖端口占用、进程提前退出和 liveness 超时,断言脚本失败原因准确、进程无残留、`publish/logs` 不存在。再把工作区版本设为高于 HEAD,验证重跑默认版本保持不变。
108
+
109
+ ## 禁止事项
110
+
111
+ - 不把数据库/Redis/MinIO 密码写入仓库、日志、命令回显或最终答复。
112
+ - 不因容器更新而删除数据库卷、对象存储卷或日志 spool。
113
+ - 不在所有节点同时硬重启。
114
+ - 不把 `docker ps` 的 Running 当作 readiness。
115
+ - 不在没有备份和恢复演练时执行数据库升级或不可逆迁移。
116
+ - 不修改 `microi.doc/docs/doc/about/update-log.md`,除非用户明确要求发版。
117
+ - 撤回或重写版本日志前,必须遵循 `../workspace-conventions/SKILL.md` 的“多对话共享工作区变更归属保护”;当天提交、最新 `HEAD`、相同作者或相关提交信息都不能单独证明改动属于当前对话。
@@ -0,0 +1,94 @@
1
+ # 部署矩阵与验收
2
+
3
+ ## 中文官网路由
4
+
5
+ | 文档 | 主要用途 |
6
+ |---|---|
7
+ | `microi.doc/docs/doc/getting-started/docker-run.md` | Docker、Compose、离线包、依赖编排 |
8
+ | `microi.doc/docs/doc/getting-started/win-install-microi.md` | Windows/IIS 安装 |
9
+ | `microi.doc/docs/doc/getting-started/local-run.md` | 后端/前端源码运行、测试与构建 |
10
+ | `microi.doc/docs/doc/getting-started/start-use.md` | 部署后创建表、表单、菜单的首条业务链路 |
11
+
12
+ 英文目录由中文生成,不作为本轮人工单独维护源。
13
+
14
+ ## 服务依赖
15
+
16
+ | 依赖 | 作用 | 生产要求 |
17
+ |---|---|---|
18
+ | API/Worker | 后端、V8、任务与接口 | 至少双节点关键场景验证 |
19
+ | Web/Nginx/IIS | 前端与反向代理 | HTTPS、上传体积、超时、静态缓存 |
20
+ | MySQL/兼容业务库 | 平台与业务数据 | 备份、字符集、连接池、慢查询 |
21
+ | Redis | 会话、缓存、租约、进度 | 持久化/高可用、按租户 Key |
22
+ | MongoDB | 日志等文档数据 | 持久卷、容量与重放验收 |
23
+ | MinIO/HDFS | 上传和应用资源 | 公私桶、持久卷、备份、CORS |
24
+
25
+ 可选依赖如翻译服务、Ollama、Qdrant 只在相应能力启用时部署,不把演示编排无条件
26
+ 带入生产。
27
+
28
+ ## 配置归类
29
+
30
+ | 配置 | 原则 |
31
+ |---|---|
32
+ | 数据库连接 | 密钥管理/环境注入,不入库明文示例 |
33
+ | Redis/Mongo/对象存储 | 全节点一致、网络可达、租户隔离 |
34
+ | AuthSecret/JWT | 集群一致;变更会影响已有登录态 |
35
+ | ApiBase/FileServer | 与反向代理外部地址一致 |
36
+ | 上传上限 | API、代理、租户配置三层一致 |
37
+ | 日志 spool | 每节点持久卷;Mongo 恢复后幂等重放 |
38
+ | 容器内存 | 多服务共机时给每容器合理 limit |
39
+
40
+ ## Docker/Compose
41
+
42
+ 执行前:
43
+
44
+ 1. 固定目标目录和 compose 文件,解析所有 volume 的绝对宿主路径。
45
+ 2. 校验镜像 tag/digest、端口、网络、重启策略、healthcheck 和 secrets。
46
+ 3. 备份数据库、对象存储与配置,并验证备份可读。
47
+ 4. `docker compose config` 只作静态校验,不代表服务可运行。
48
+
49
+ 发布时一次只替换部分 API 节点;readiness 正常后再替换下一节点。数据库和对象存储
50
+ 卷不随应用容器重建删除。Watchtower/自动更新若启用,必须保证 AuthSecret、配置卷和
51
+ 健康检查不因容器替换漂移。
52
+
53
+ 离线安装包要包含精确镜像、校验和、compose、配置模板和安装说明;目标机导入后复核
54
+ 镜像 digest,不能只看文件解压成功。
55
+
56
+ ## Windows/IIS
57
+
58
+ 至少核对:
59
+
60
+ - .NET Hosting Bundle 与应用目标框架匹配;
61
+ - Application Pool 使用无托管代码并具备目录权限;
62
+ - API 和 Web 站点绑定、HTTPS、反向代理与 WebSocket 配置;
63
+ - 应用数据、上传、日志和 spool 目录不放临时发布目录;
64
+ - Windows 服务/计划任务不会与 IIS 节点重复执行同一后台任务;
65
+ - MySQL、Redis、MongoDB、MinIO 服务开机启动和恢复策略。
66
+
67
+ IIS 进程启动不代表 API 可用,仍要检查 readiness 和真实登录路径。
68
+
69
+ ## 本地源码运行
70
+
71
+ 后端:
72
+
73
+ - 使用当前仓库规定的 .NET SDK;
74
+ - 配置开发专用数据库/Redis/Mongo/对象存储;
75
+ - 先跑定向测试,再按资源允许程度执行更大构建;
76
+ - 不让本地调试连接生产写库。
77
+
78
+ 前端:
79
+
80
+ - 使用仓库规定的 Node/npm/pnpm 版本;
81
+ - 复用已有 Vite 服务,不重复启动;
82
+ - 本地页面成功不替代宿主 Token、OsClient、菜单权限和生产构建验收。
83
+
84
+ ## 最小上线验收
85
+
86
+ - API liveness 200,readiness 200;依赖降级能在 readiness/日志中体现。
87
+ - Web 首屏、登录、退出、Token 刷新正常。
88
+ - 管理员与普通角色各验证一个菜单和数据权限。
89
+ - FormEngine 新增/编辑/查询,ApiEngine 调用正常。
90
+ - 公有/私有文件各上传、预览/下载一次,Range/HEAD 按需验证。
91
+ - Redis/Mongo/对象存储短暂不可用后可恢复,无永久死锁或静默丢失。
92
+ - 双节点同时触发同一 Job/消息,业务副作用仅一次。
93
+ - 发布中终止一个节点,其余节点继续服务;恢复节点不重复初始化。
94
+ - 回滚步骤和恢复点已实际验证或明确标记未验证。
@@ -0,0 +1,91 @@
1
+ ---
2
+ name: microi-docs-coverage
3
+ description: Microi 中文官网文档与 Skills 能力覆盖审计。用于全面分析 microi.doc/docs/doc、核对官方能力和 V8 函数是否已进入 microi.skills、补充或重构 Skills、维护文档到 Skill 的责任映射,以及防止后续新增中文文档造成 AI 知识漏项。
4
+ ---
5
+
6
+ # Microi 中文官网文档与 Skills 覆盖审计
7
+
8
+ 当任务涉及“官网有但 AI 不知道”“全面同步官方文档到 Skills”“核对所有
9
+ V8 函数”或新增、调整官方中文文档时,使用本 Skill。
10
+
11
+ ## 范围与事实源
12
+
13
+ - 扫描 `microi.doc/docs/doc/**/*.md`,但排除
14
+ `microi.doc/docs/doc/about/update-log.md`。
15
+ - 不扫描、不手工维护 `microi.doc/docs/en/`;英文站由中文站统一翻译。
16
+ - `references/capability-map.md` 维护每篇中文文档的责任 Skill。
17
+ - 文档描述能力边界,当前源码、接口定义、组件清单和 MCP Schema 决定真实签名。
18
+ - 不把客户表名、业务字段、扩展数据库名称或示例返回字段误判为平台 API。
19
+
20
+ ## 审计流程
21
+
22
+ 1. 运行自动审计:
23
+
24
+ ```powershell
25
+ node microi.skills/microi-docs-coverage/scripts/audit-doc-skill-coverage.mjs
26
+ ```
27
+
28
+ 2. 先解决“未映射文档”和“无效责任 Skill”。每篇中文文档都必须在能力映射中
29
+ 有明确负责人;宣传、培训、FAQ 等非 API 页面也要标明信息型覆盖。
30
+ 3. 查看“未覆盖 V8 API、其它具名 API、MCP 工具”。逐项回到中文文档和
31
+ 当前源码确认:
32
+ - 真实平台 API:补到对应 Skill 或 `v8-utilities` 索引。
33
+ - 业务数据路径:归一为 `V8.Form`、`V8.Param` 等上下文对象。
34
+ - 动态扩展名:归一为 `V8.Dbs`,不要固化客户数据库名称。
35
+ - 文档旧名或错误:以源码为准,说明兼容边界;不要为让审计通过而虚构 API。
36
+ 4. 把高频决策和最小安全示例写进 `SKILL.md`;完整方法表、平台差异、硬件/
37
+ 部署验收写进 `references/`,保持渐进披露。
38
+ 5. 更新 `references/capability-map.md`,重新运行审计,直到严格检查通过。
39
+ 6. 对每个新增或改动的 Skill 运行 `skill-creator` 的 `quick_validate.py`,
40
+ 再执行 `git diff --check` 和相对链接检查。
41
+
42
+ ## 自动审计能证明什么
43
+
44
+ 脚本验证:
45
+
46
+ - 中文文档清单与责任映射闭环;
47
+ - 映射中没有已删除文档或不存在的 Skill;
48
+ - 文档出现的标准化 `V8.*` 名称至少在某个 Skill Markdown 中出现;
49
+ - 文档出现的 `System`、`DiyCommon`、`SqlFunc`、`SqlSubQuery`、
50
+ `V8ExtensionRegistry` 具名 API 至少在某个 Skill 中出现;
51
+ - 文档出现的 `microi_*` MCP 工具名至少在某个 Skill 中出现;
52
+ - 文档出现的平台 HTTP 路由和平台全局函数至少在某个 Skill 中出现;
53
+ - 当前前端组件清单中的全部 `Control` 已进入表单组件参考;
54
+ - `v8-print.js`、`ble/tsc.js`、`ble/esc.js` 的公开蓝牙入口和全部构建器方法,
55
+ 已同时进入中文官方文档、蓝牙 Skills 与前端 Monaco API 提示;
56
+ - `diy.common.js`、`diy-form.vue`、`diy-table.vue` 仍真实调用
57
+ `initV8Print`,且三处挂载范围已写入官方文档与 Skill;
58
+ - 动态业务路径被单独列出,便于人工复核。
59
+
60
+ 脚本不能证明:
61
+
62
+ - Skill 的语义、示例、安全约束一定正确;
63
+ - 文档本身没有过时;
64
+ - 浏览器、蓝牙设备、打印机、数据库或多节点部署已经实测。
65
+
66
+ 因此每轮全面同步还要做源码核对和按风险分层的真实验收,不能只追求字符串
67
+ 覆盖率。
68
+
69
+ ## 补充内容的归属
70
+
71
+ - 前端通用 API、扫码、消息、表格/表单助手:`v8-utilities`、
72
+ `v8-frontend-events`。
73
+ - 蓝牙直连运行、连接与批量语义:
74
+ `v8-frontend-events/references/bluetooth-print.md`;TSC/ESC 源码方法与编码:
75
+ `v8-frontend-events/references/bluetooth-print-api.md`;服务端模板打印仍归
76
+ `print-engine`。
77
+ - 后端通用上下文、Method、Base64、加密:`v8-utilities`。
78
+ - 表单设计器和字段组件:`microi-form-engine`。
79
+ - 菜单、模块与页面入口:`module-engine`。
80
+ - 部署、运行、配置和升级:`microi-deployment`。
81
+ - Dos.ORM 与扩展数据库:`dos-orm`。
82
+ - 微服务/前端微应用:`microi-microservice`。
83
+ - 其它专项能力优先补到已有同名 Engine/V8 Skill,避免再建内容重叠的 Skill。
84
+
85
+ ## 禁止事项
86
+
87
+ - 不复制整篇官网文档到一个巨型 Skill。
88
+ - 不用叶子方法同名匹配掩盖对象归属错误。
89
+ - 不把 `V8.Form.OrderNo`、`V8.Param.id` 等业务字段当成平台函数。
90
+ - 不为了本次普通补充修改版本更新日志、英文文档或 Skills 版本清单。
91
+ - 不声称静态审计等于真实硬件、浏览器、远端或生产验收。
@@ -0,0 +1,65 @@
1
+ # 中文官网文档到 Skill 的责任映射
2
+
3
+ 本表覆盖 `microi.doc/docs/doc/` 下除 `about/update-log.md` 之外的全部中文
4
+ Markdown。第一列是相对 `microi.doc/docs/doc/` 的路径;第二列 Skill 名必须与
5
+ `microi.skills/<name>/SKILL.md` 一致。
6
+
7
+ | 中文文档 | 责任 Skill | 覆盖重点 |
8
+ |---|---|---|
9
+ | `about/faq.md` | microi-system-delivery, microi-deployment | 常见问题、能力边界和故障路由 |
10
+ | `about/microi-training-syllabus.md` | microi-system-delivery, business-blueprint | 培训知识域和交付全景 |
11
+ | `about/partner.md` | microi-system-delivery | 信息型页面;产品与交付能力索引 |
12
+ | `about/template.md` | microi-system-delivery | 信息型页面;官方内容模板 |
13
+ | `form-engine/all-form-component.md` | microi-form-engine, microi-form-layout | 当前组件目录、物理类型和布局 |
14
+ | `form-engine/form-custom-control.md` | microi-form-engine, microi-client-frontend | 定制控件、前端扩展边界 |
15
+ | `form-engine/form-datasource.md` | microi-form-engine, microi-datasource-mapping | 选项数据源、联动和回显 |
16
+ | `form-engine/form-engine-info.md` | microi-form-engine, v8-crud-api | 表单模型和运行时能力 |
17
+ | `form-engine/form-field-info.md` | microi-form-engine, v8-table-event | 表单/字段属性与事件 |
18
+ | `form-engine/model-engine.md` | v8-template-engine | 表格/表单模板 |
19
+ | `getting-started/docker-run.md` | microi-deployment | Docker 部署与验收 |
20
+ | `getting-started/local-run.md` | microi-deployment | 源码本地运行 |
21
+ | `getting-started/start-use.md` | microi-system-delivery, module-engine | 快速使用和首个模块 |
22
+ | `getting-started/win-install-microi.md` | microi-deployment | Windows 部署 |
23
+ | `index.md` | microi-system-delivery | 产品能力总览和知识路由 |
24
+ | `more/copy-module.md` | module-engine, app-store | 模块复制、迁移和依赖 |
25
+ | `more/db-dictionary.md` | microi-db-schema | 核心表和字段归属 |
26
+ | `more/dos-orm.md` | dos-orm, v8-sql-query | ORM 查询、参数和事务 |
27
+ | `more/dos-result.md` | v8-utilities, v8-crud-api | DosResult/DosResultList 返回协议 |
28
+ | `more/hdfs.md` | v8-file-upload | 分布式文件存储和 URL |
29
+ | `more/office.md` | v8-export-import, microi-microservice | Office 导入导出与在线编辑集成 |
30
+ | `more/security.md` | v8-security | 平台安全和兼容基线 |
31
+ | `more/sys-config.md` | v8-utilities, microi-deployment | 系统/租户配置和敏感边界 |
32
+ | `system-engine/ai-engine.md` | ai-engine | 模型代理、AI 引擎和安全 |
33
+ | `system-engine/app-store.md` | app-store | 应用包、安装、升级和回滚 |
34
+ | `system-engine/databases.md` | dos-orm, v8-sql-query, microi-deployment | 扩展数据库与迁移 |
35
+ | `system-engine/datasource-engine.md` | datasource-engine | 数据源定义、执行和供数 |
36
+ | `system-engine/job.md` | job-engine | 调度、后台任务和分布式恢复 |
37
+ | `system-engine/micro-app.md` | microi-microservice, microi-ai-application | 微服务/AI 前端应用的工程架构与交付 |
38
+ | `system-engine/microi-ui.md` | microi-ui | Microi.UI 组件和主题 |
39
+ | `system-engine/module-engine.md` | module-engine, v8-menu-buttons, v8-template-engine, microi-mobile-app-quality | 菜单统计、模块指标、复合列、移动卡片、按钮角标和页面入口 |
40
+ | `system-engine/mq.md` | v8-mq-mqtt | RabbitMQ 生产与消费 |
41
+ | `system-engine/mqtt-engine.md` | v8-mq-mqtt | MQTT 事件与 IoT |
42
+ | `system-engine/page-engine.md` | page-engine | 界面引擎 JSON |
43
+ | `system-engine/print-engine.md` | print-engine, v8-frontend-events | 服务端模板打印与蓝牙直连边界 |
44
+ | `system-engine/report-engine.md` | report-engine | 虚拟报表和导出 |
45
+ | `system-engine/saas-engine.md` | v8-saas-multi-tenant | 租户识别和 SaaS 配置 |
46
+ | `system-engine/search-engine.md` | search-engine | Elasticsearch 索引和查询 |
47
+ | `system-engine/spider-engine.md` | spider-engine | 浏览器采集和 Worker |
48
+ | `system-engine/translate-engine.md` | translate-engine | 多语言与翻译供应商 |
49
+ | `system-engine/wf-engine.md` | v8-workflow | 工作流设计和事件 |
50
+ | `v8-engine/ai-apiengine.md` | ai-engine, v8-api-config | AI 辅助接口引擎开发 |
51
+ | `v8-engine/api-engine.md` | v8-api-config, v8-utilities | 接口上下文、配置和调用 |
52
+ | `v8-engine/apiengine-index.md` | v8-crud-api, v8-api-config | 接口引擎实战和规范 |
53
+ | `v8-engine/form-engine.md` | v8-crud-api, v8-formengine-http | FormEngine API 与 HTTP |
54
+ | `v8-engine/v8-client.md` | v8-utilities, v8-frontend-events, print-engine | 全部前端 V8、扫码和蓝牙打印 |
55
+ | `v8-engine/v8-server.md` | v8-utilities, v8-api-config | 全部后端 V8 和专项路由 |
56
+ | `v8-engine/vs-code-plugin.md` | v8-explorer-tree, microi-client-frontend, workspace-conventions | VS Code 插件、Microi CLI、AI/MCP 初始化、类型、资源树和共享工作区 |
57
+ | `v8-engine/where.md` | v8-crud-api, v8-sql-query | 参数化 `_Where` 条件 |
58
+
59
+ ## 维护规则
60
+
61
+ - 中文文档新增、删除或移动时,同一变更必须更新本表。
62
+ - 一篇文档可以有多个责任 Skill,但第一个应是主要承载者。
63
+ - “责任 Skill”不是把全文复制过去,而是保证 AI 能发现能力、调用正确 API、
64
+ 遵守安全边界并找到详细参考。
65
+ - 方法签名发生冲突时回查当前源码;文档旧写法仅作为兼容说明。