@microi.net/cli 5.8.5 → 5.8.7
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/.codebuddy-plugin/marketplace.json +2 -2
- package/.codebuddy-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +1 -1
- package/.workbuddy-plugin/marketplace.json +2 -2
- package/.workbuddy-plugin/plugin.json +1 -1
- package/LICENSE +21 -21
- package/README.md +71 -71
- package/assets/build-meta.json +7 -7
- package/assets/feature-matrix.json +138 -138
- package/assets/logo.svg +4 -4
- package/cordis.patch.yml +1 -1
- package/package.json +1 -1
- package/scripts/mcp-codex-stdio-adapter.js +0 -0
- package/scripts/mcp-server.js +1 -1
- package/scripts/microi-cli.js +66 -65
- package/scripts/microi-codex-broker.js +450 -450
- package/scripts/microi-codex-router.js +618 -618
- package/scripts/microi-skills.meta.json +384 -384
- package/skills/.microi-skills-version.json +2 -2
- package/skills/.progressive-disclosure-manifest.json +21 -21
- package/skills/README.md +287 -287
- package/skills/ai-engine/SKILL.md +269 -265
- package/skills/ai-engine/agents/openai.yaml +4 -4
- package/skills/ai-engine/references/ai-employees.md +48 -48
- package/skills/ai-engine/references/self-hosted-digital-human.md +59 -59
- package/skills/ai-platform-governance/SKILL.md +177 -177
- package/skills/ai-platform-governance/references/progressive-01-/345/212/237/350/203/275/345/274/200/345/205/263.md +190 -190
- package/skills/app-store/SKILL.md +525 -525
- package/skills/app-store/agents/openai.yaml +4 -4
- package/skills/business-blueprint/SKILL.md +193 -193
- package/skills/datasource-engine/SKILL.md +93 -93
- package/skills/datasource-engine/agents/openai.yaml +4 -4
- package/skills/dos-orm/SKILL.md +97 -95
- package/skills/dos-orm/references/api-reference.md +229 -229
- package/skills/email-engine/SKILL.md +81 -81
- package/skills/email-engine/references/v8-email.md +34 -34
- package/skills/job-engine/SKILL.md +176 -176
- package/skills/job-engine/agents/openai.yaml +4 -4
- package/skills/message-notification/SKILL.md +156 -156
- package/skills/message-notification/agents/openai.yaml +5 -5
- package/skills/message-notification/references/contracts.md +102 -102
- package/skills/microi/SKILL.md +14 -14
- package/skills/microi-ai-app-auth.js +652 -652
- package/skills/microi-ai-application/SKILL.md +115 -115
- package/skills/microi-ai-application/agents/openai.yaml +4 -4
- package/skills/microi-ai-application/references/frontend-baseline.md +164 -164
- package/skills/microi-client-frontend/SKILL.md +246 -244
- package/skills/microi-client-frontend/references/progressive-01-3-/345/212/250/346/200/201/346/214/211/351/222/256/347/263/273/347/273/237.md +144 -144
- package/skills/microi-client-frontend/references/progressive-02-8-/350/277/220/350/241/214/346/227/266/351/253/230/351/242/221/345/235/221/345/244/215/347/233/230.md +196 -196
- package/skills/microi-client-frontend/references/progressive-03-vue3-/345/211/215/347/253/257/345/276/256/346/234/215/345/212/241/345/256/277/344/270/273/350/247/204/345/210/231.md +167 -167
- package/skills/microi-codex/SKILL.md +102 -100
- package/skills/microi-codex-installer/SKILL.md +231 -231
- package/skills/microi-codex-installer/agents/openai.yaml +7 -7
- package/skills/microi-datasource-mapping/SKILL.md +122 -122
- package/skills/microi-db-schema/SKILL.md +175 -175
- package/skills/microi-db-schema/agents/openai.yaml +4 -4
- package/skills/microi-db-schema/references/core-tables.md +695 -695
- package/skills/microi-db-schema/references/form-component-options.md +256 -256
- package/skills/microi-db-schema/references/schema-overview.md +202 -202
- package/skills/microi-db-schema/references/schema.md +646 -646
- package/skills/microi-db-schema/references/table-catalog.md +1599 -1599
- package/skills/microi-deployment/SKILL.md +222 -220
- package/skills/microi-deployment/references/deployment-matrix.md +109 -109
- package/skills/microi-docs-coverage/SKILL.md +133 -133
- package/skills/microi-docs-coverage/references/capability-map.md +91 -91
- package/skills/microi-docs-coverage/scripts/audit-doc-skill-coverage.mjs +894 -894
- package/skills/microi-form-engine/SKILL.md +333 -333
- package/skills/microi-form-engine/references/component-catalog.md +218 -218
- package/skills/microi-form-engine/references/data-source-events.md +124 -124
- package/skills/microi-form-layout/SKILL.md +205 -205
- package/skills/microi-form-layout/references/progressive-01-3-/344/270/211/347/247/215/345/210/206/347/273/204/347/232/204/345/255/230/345/202/250/344/270/216/351/205/215/347/275/256.md +235 -235
- package/skills/microi-frontend-sdk/SKILL.md +194 -194
- package/skills/microi-frontend-sdk/references/progressive-01-token-/345/275/223/345/211/215/347/231/273/345/275/225/347/224/250/346/210/267/344/270/216/345/275/223/345/211/215/347/273/210/347/253/257/347/231/273/345/275/225/345/215/217/350/256/256.md +176 -176
- package/skills/microi-left-right-layout/SKILL.md +141 -141
- package/skills/microi-microservice/SKILL.md +328 -326
- package/skills/microi-microservice/references/runtime-delivery.md +278 -278
- package/skills/microi-mobile-app-quality/SKILL.md +185 -185
- package/skills/microi-mobile-app-quality/references/progressive-01-4-/351/207/215/350/246/201/346/214/211/351/222/256/345/277/205/351/241/273/345/270/246/345/233/276/346/240/207.md +213 -213
- package/skills/microi-mobile-app-quality/references/progressive-02-9-/344/270/273/351/242/230/345/210/207/346/215/242/345/277/205/351/241/273/347/234/237/345/256/236/344/270/224/345/205/250/345/261/200/347/224/237/346/225/210.md +128 -128
- package/skills/microi-solution-quotation/SKILL.md +78 -78
- package/skills/microi-solution-quotation/agents/openai.yaml +4 -4
- package/skills/microi-solution-quotation/scripts/build_solution_quote.py +296 -296
- package/skills/microi-sso/SKILL.md +96 -90
- package/skills/microi-sso/references/acceptance.md +49 -49
- package/skills/microi-sso/references/configuration-and-security.md +53 -53
- package/skills/microi-sso/references/inbound.md +53 -53
- package/skills/microi-sso/references/outbound.md +39 -39
- package/skills/microi-system-delivery/SKILL.md +137 -137
- package/skills/microi-system-delivery/references/progressive-01-/346/240/207/345/207/206/345/267/245/344/275/234/346/265/201.md +193 -193
- package/skills/microi-system-delivery/references/progressive-02-/350/207/252/345/212/250/345/214/226/346/265/213/350/257/225/345/277/205/351/241/273/350/246/206/347/233/226/347/232/204/345/235/221.md +217 -217
- package/skills/microi-ui/SKILL.md +192 -192
- package/skills/microi-ui/references/progressive-01-/347/247/273/345/212/250/347/253/257/345/234/272/346/231/257/350/223/235/345/233/276.md +183 -183
- package/skills/microi-uniapp-frontend/SKILL.md +193 -193
- package/skills/microi-uniapp-frontend/references/progressive-01-/347/247/273/345/212/250/347/253/257/345/210/206/347/261/273-/345/217/214/346/240/217/345/210/227/350/241/250/347/213/254/347/253/213/346/273/232/345/212/250.md +225 -225
- package/skills/microi-uniapp-frontend/references/progressive-02-/345/205/263/351/224/256/344/270/232/345/212/241/350/265/204/344/272/247/344/270/215/345/276/227/351/273/230/350/256/244/351/200/211/344/270/255.md +154 -154
- package/skills/microi.v8.js +1921 -1921
- package/skills/module-engine/SKILL.md +255 -255
- package/skills/module-engine/references/module-config.md +204 -204
- package/skills/ocr-engine/SKILL.md +113 -113
- package/skills/ocr-engine/agents/openai.yaml +4 -4
- package/skills/page-engine/SKILL.md +206 -206
- package/skills/page-engine/examples/compact-dashboard.json +1444 -1444
- package/skills/page-engine/references/progressive-01-/346/211/200/346/234/211/347/273/204/344/273/266/347/261/273/345/236/213.md +234 -234
- package/skills/page-engine/references/progressive-02-/347/211/210/346/234/254/345/216/206/345/217/262-/345/271/266/345/217/221/344/277/235/345/255/230/344/270/216/345/233/236/346/273/232.md +60 -60
- package/skills/performance-testing/SKILL.md +221 -221
- package/skills/playwright-e2e/SKILL.md +196 -196
- package/skills/playwright-e2e/references/progressive-01-/345/205/250/350/207/252/345/212/250/347/231/273/345/275/225-/345/205/215/351/252/214/350/257/201/347/240/201-/344/275/206/344/270/215/345/205/215/345/257/206/347/240/201-/345/277/205/350/257/273.md +173 -173
- package/skills/playwright-e2e/references/progressive-02-/346/226/207/345/255/227/345/257/271/346/257/224/345/272/246/344/270/216/345/217/257/350/257/273/346/200/247/350/207/252/345/212/250/345/214/226/346/243/200/346/237/245-/345/277/205/345/201/232.md +183 -183
- package/skills/playwright-e2e/references/progressive-03-microi-helper-/346/250/241/346/235/277.md +221 -221
- package/skills/playwright-e2e/references/progressive-04-ci-/345/273/272/350/256/256.md +115 -115
- package/skills/print-engine/SKILL.md +259 -259
- package/skills/production-readonly-audit/SKILL.md +41 -41
- package/skills/report-engine/SKILL.md +71 -71
- package/skills/report-engine/agents/openai.yaml +4 -4
- package/skills/scripts/optimize-progressive-disclosure.mjs +204 -204
- package/skills/scripts/refresh-progressive-disclosure.mjs +64 -64
- package/skills/scripts/sync-embedded-skills.mjs +46 -46
- package/skills/scripts/validate-progressive-disclosure.mjs +57 -57
- package/skills/search-engine/SKILL.md +75 -75
- package/skills/search-engine/agents/openai.yaml +4 -4
- package/skills/spider-engine/SKILL.md +190 -190
- package/skills/system-observability/SKILL.md +249 -246
- package/skills/system-observability/references/memory-incident-triage.md +77 -77
- package/skills/translate-engine/SKILL.md +140 -140
- package/skills/translate-engine/agents/openai.yaml +4 -4
- package/skills/ui-design/SKILL.md +223 -223
- package/skills/ui-design/assets/pattern-showcase/app.js +54 -54
- package/skills/ui-design/assets/pattern-showcase/index.html +163 -163
- package/skills/ui-design/assets/pattern-showcase/styles.css +311 -311
- package/skills/ui-design/assets/templates/MCI-DESIGN.md +206 -206
- package/skills/ui-design/references/design-pattern-library.md +184 -184
- package/skills/ui-design/references/mci-design-contract.md +163 -163
- package/skills/ui-design/references/motion-and-media.md +78 -78
- package/skills/ui-design/references/product-flow-recipes.md +94 -94
- package/skills/ui-design/references/progressive-01-/351/242/234/350/211/262/344/275/223/347/263/273-css-variables-/346/224/257/346/214/201/344/270/273/351/242/230/345/210/207/346/215/242.md +218 -218
- package/skills/ui-design/references/progressive-02-/345/255/227/344/275/223.md +164 -164
- package/skills/ui-design/references/progressive-03-/345/212/250/346/225/210/350/247/204/350/214/203-/344/270/260/345/257/214/344/275/206/344/270/215/345/215/241.md +235 -235
- package/skills/ui-design/references/progressive-04-/347/273/204/344/273/266/351/243/216/346/240/274/351/200/237/346/237/245.md +152 -152
- package/skills/ui-design/references/progressive-05-/347/247/273/345/212/250/347/253/257/344/270/223/347/224/250/350/247/204/350/214/203.md +238 -238
- package/skills/ui-design/references/progressive-06-/344/270/273/351/242/230/345/210/207/346/215/242/345/256/236/347/216/260.md +194 -194
- package/skills/ui-design/references/progressive-07-/351/200/237/346/237/245-/344/273/216/345/244/264/346/220/255/345/273/272/344/270/200/344/270/252/347/247/273/345/212/250/347/253/257/351/241/265/351/235/242.md +207 -207
- package/skills/ui-design/references/progressive-08-/350/241/250/345/215/225/345/210/206/347/273/204/350/247/204/350/214/203-tabs-vs-collapsegroup-/345/274/272/345/210/266.md +142 -142
- package/skills/uniapp-mall-assets/SKILL.md +176 -176
- package/skills/unity-integration/SKILL.md +171 -171
- package/skills/unity-integration/agents/openai.yaml +4 -4
- package/skills/unity-integration/references/ai-app-delivery.md +119 -119
- package/skills/unity-integration/references/sdk-api.md +82 -82
- package/skills/unity-integration/references/toolbox-migration.md +66 -66
- package/skills/unity-integration/references/webgl-hosting.md +57 -57
- package/skills/v8-api-config/SKILL.md +388 -388
- package/skills/v8-cache-pattern/SKILL.md +312 -312
- package/skills/v8-crud-api/SKILL.md +178 -178
- package/skills/v8-crud-api/references/progressive-01-/346/237/245/350/257/242/345/210/227/350/241/250-/345/210/206/351/241/265.md +226 -226
- package/skills/v8-crud-api/references/progressive-02-where-/346/235/241/344/273/266/350/257/255/346/263/225/351/200/237/346/237/245.md +49 -49
- package/skills/v8-debugging/SKILL.md +284 -284
- package/skills/v8-explorer-tree/SKILL.md +228 -228
- package/skills/v8-export-import/SKILL.md +219 -219
- package/skills/v8-export-import/references/progressive-01-excellayout-/351/253/230/347/272/247/350/207/252/347/224/261/345/270/203/345/261/200.md +211 -211
- package/skills/v8-export-import/references/progressive-02-powerpoint-/345/257/274/345/207/272.md +202 -202
- package/skills/v8-export-import/references/progressive-03-/345/256/211/345/205/250-/346/200/247/350/203/275/346/263/250/346/204/217.md +42 -42
- package/skills/v8-file-upload/SKILL.md +284 -284
- package/skills/v8-file-upload/references/progressive-01-/345/205/254/346/234/211/346/241/266-vs-/347/247/201/346/234/211/346/241/266.md +263 -263
- package/skills/v8-file-upload/references/progressive-02-office-/346/226/207/344/273/266/345/234/250/347/272/277/347/274/226/350/276/221/347/211/210/346/234/254/345/217/267/350/247/204/345/210/231.md +161 -161
- package/skills/v8-formengine-http/SKILL.md +238 -238
- package/skills/v8-frontend-events/SKILL.md +180 -180
- package/skills/v8-frontend-events/references/bluetooth-print-api.md +135 -135
- package/skills/v8-frontend-events/references/bluetooth-print.md +258 -258
- package/skills/v8-frontend-events/references/progressive-01-/345/210/227/350/241/250/344/272/213/344/273/266.md +219 -219
- package/skills/v8-http-integration/SKILL.md +182 -182
- package/skills/v8-http-integration/references/progressive-01-get-/350/257/267/346/261/202.md +220 -220
- package/skills/v8-http-integration/references/progressive-02-/351/224/231/350/257/257/345/244/204/347/220/206/346/250/241/345/274/217.md +44 -44
- package/skills/v8-image-processing/SKILL.md +190 -190
- package/skills/v8-image-processing/agents/openai.yaml +4 -4
- package/skills/v8-image-processing/references/api-reference.md +623 -623
- package/skills/v8-menu-buttons/SKILL.md +186 -186
- package/skills/v8-menu-buttons/references/progressive-01-2-/346/214/211/351/222/256/345/257/271/350/261/241-schema.md +222 -222
- package/skills/v8-menu-buttons/references/progressive-02-8-/346/250/241/345/274/217-f-/345/220/216/345/217/260/344/273/273/345/212/241/346/214/211/351/222/256-/351/225/277/344/273/273/345/212/241.md +228 -228
- package/skills/v8-menu-buttons/references/progressive-03-10-/345/217/215/346/250/241/345/274/217-/351/201/277/345/205/215.md +104 -104
- package/skills/v8-mongodb/SKILL.md +200 -200
- package/skills/v8-mq-mqtt/SKILL.md +176 -176
- package/skills/v8-mq-mqtt/references/mqtt-production.md +342 -342
- package/skills/v8-mq-mqtt/references/progressive-01-v8-mqtt-iot-/347/211/251/350/201/224/347/275/221.md +181 -181
- package/skills/v8-mq-mqtt/scripts/check-mqtt-skill-coverage.mjs +203 -203
- package/skills/v8-saas-multi-tenant/SKILL.md +305 -305
- package/skills/v8-security/SKILL.md +210 -210
- package/skills/v8-security/references/progressive-01-2-/346/235/203/351/231/220/346/240/241/351/252/214.md +200 -200
- package/skills/v8-security/references/progressive-02-7-/346/227/245/345/277/227/350/256/260/345/275/225.md +160 -160
- package/skills/v8-sql-query/SKILL.md +302 -302
- package/skills/v8-table-event/SKILL.md +176 -176
- package/skills/v8-table-event/references/progressive-01-informv8-js-/350/241/250/345/215/225/346/211/223/345/274/200/344/272/213/344/273/266.md +216 -216
- package/skills/v8-table-event/references/progressive-02-/345/211/215/347/253/257/344/272/213/344/273/266/345/220/215-v8-eventname-/345/217/257/350/203/275/347/232/204/345/200/274.md +46 -46
- package/skills/v8-tcp-integration/SKILL.md +147 -147
- package/skills/v8-tcp-integration/agents/openai.yaml +4 -4
- package/skills/v8-template-engine/SKILL.md +167 -167
- package/skills/v8-utilities/SKILL.md +104 -104
- package/skills/v8-utilities/references/client-api-index.md +143 -143
- package/skills/v8-utilities/references/platform-http-routes.md +83 -83
- package/skills/v8-utilities/references/server-api-index.md +188 -188
- package/skills/v8-workflow/SKILL.md +252 -252
- package/skills/v8-workflow/references/progressive-01-/350/212/202/347/202/271/345/274/200/345/247/213-v8-/344/272/213/344/273/266.md +180 -180
- package/skills/v8-workflow/references/workflow-configuration.md +49 -49
- package/skills/vision-engine/SKILL.md +160 -160
- package/skills/vision-engine/agents/openai.yaml +4 -4
- package/skills/vision-engine/references/architecture-and-acceptance.md +194 -194
- package/skills/workspace-conventions/SKILL.md +273 -273
- package/skills/workspace-conventions/references/progressive-01-/347/211/210/346/234/254/346/233/264/346/226/260/346/227/245/345/277/227/344/277/235/346/212/244/350/247/204/345/210/231-/345/274/272/345/210/266.md +209 -209
- package/skills/workspace-conventions/references/progressive-02-microi-net-api-/346/234/254/345/234/260/345/220/257/345/212/250/347/272/246/345/256/232.md +217 -217
- package/skills/workspace-conventions/references/progressive-03-cli-/344/270/216-ide-/346/217/222/344/273/266/351/224/231/347/211/210/345/205/261/345/255/230/347/272/246/345/256/232.md +27 -27
|
@@ -1,109 +1,109 @@
|
|
|
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
|
-
macOS 的一键发布探针通过 `run_with_timeout` 使用 GNU `timeout`、`gtimeout` 或仓库 Node 工具 `Microi.Server/tools/run-with-timeout.mjs`。缺少 GNU 命令不能据此判定 Docker 不健康;超时工具只停止自身创建的探针进程。官网专用选项 6 不发布 DLL/NuGet,后端发布的加密门禁保持有效。
|
|
72
|
-
|
|
73
|
-
Obfuscar 路径转换只适用于 Git Bash/MSYS/Cygwin。macOS/Linux 的 `/Users`、`/usr` 等绝对路径直接传给工具;Windows 优先 `cygpath`,无该命令时只转换完整盘符根路径。修复后使用隔离副本验证五个 DLL 和指纹,再重新执行一键脚本的 Full 与最终加密产物冒烟。
|
|
74
|
-
|
|
75
|
-
在线 AI MCP 的生产依赖和命令复制为完整、自足的运行快照,生产命令链接解析为真实文件,保留执行权限;损坏、越界及目录循环链接提前拒绝。临时构建目录清理后命令必须仍能运行,旧依赖不得残留;不放宽原制品门禁。
|
|
76
|
-
|
|
77
|
-
前端构建的 macOS 可用内存按有界 `vm_stat` 的真实页大小计算空闲页加可回收文件页,不叠加匿名非活动、压缩或预读页。解析失败和探针超时回退原生空闲量;Windows/Linux 保持原统计方式。启动预算、95% 暂停、90% 恢复及连续五秒稳定门禁不变,正式发布不能跳过保护;统计错误应修正探针,并保留共享服务。
|
|
78
|
-
|
|
79
|
-
后端:
|
|
80
|
-
|
|
81
|
-
- 使用当前仓库规定的 .NET SDK;
|
|
82
|
-
- 配置开发专用数据库/Redis/Mongo/对象存储;
|
|
83
|
-
- 先跑定向测试,再按资源允许程度执行更大构建;
|
|
84
|
-
- 不让本地调试连接生产写库。
|
|
85
|
-
|
|
86
|
-
前端:
|
|
87
|
-
|
|
88
|
-
- 使用仓库规定的 Node/npm/pnpm 版本;
|
|
89
|
-
- 复用已有 Vite 服务,不重复启动;
|
|
90
|
-
- `src/config.json` 的 `ApiBaseDev` 是默认值;本地 URL 可在 `#` 前用
|
|
91
|
-
`?OsClient=...&ApiBase=...` 以最高优先级覆盖 ApiBase 与租户;
|
|
92
|
-
- 多组 `ApiBase + OsClient` 并行时按组创建独立浏览器 Profile/进程或 Playwright context,不能在
|
|
93
|
-
同一同源 context 的多个 Page 中混测;
|
|
94
|
-
- 人工第二组至少使用无痕窗口,但多个 Chrome 无痕窗口可能共享临时会话,不能承担多组强隔离;
|
|
95
|
-
- 从线上页面读取 `window.__MICROI_RUNTIME_ENDPOINT__`;旧版无该对象时按 URL、window 全局、
|
|
96
|
-
同源状态、域名解析/成功请求逐级确认,禁止猜测;
|
|
97
|
-
- 本地页面成功不替代宿主 Token、OsClient、菜单权限和生产构建验收。
|
|
98
|
-
|
|
99
|
-
## 最小上线验收
|
|
100
|
-
|
|
101
|
-
- API liveness 200,readiness 200;依赖降级能在 readiness/日志中体现。
|
|
102
|
-
- Web 首屏、登录、退出、Token 刷新正常。
|
|
103
|
-
- 管理员与普通角色各验证一个菜单和数据权限。
|
|
104
|
-
- FormEngine 新增/编辑/查询,ApiEngine 调用正常。
|
|
105
|
-
- 公有/私有文件各上传、预览/下载一次,Range/HEAD 按需验证。
|
|
106
|
-
- Redis/Mongo/对象存储短暂不可用后可恢复,无永久死锁或静默丢失。
|
|
107
|
-
- 双节点同时触发同一 Job/消息,业务副作用仅一次。
|
|
108
|
-
- 发布中终止一个节点,其余节点继续服务;恢复节点不重复初始化。
|
|
109
|
-
- 回滚步骤和恢复点已实际验证或明确标记未验证。
|
|
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
|
+
macOS 的一键发布探针通过 `run_with_timeout` 使用 GNU `timeout`、`gtimeout` 或仓库 Node 工具 `Microi.Server/tools/run-with-timeout.mjs`。缺少 GNU 命令不能据此判定 Docker 不健康;超时工具只停止自身创建的探针进程。官网专用选项 6 不发布 DLL/NuGet,后端发布的加密门禁保持有效。
|
|
72
|
+
|
|
73
|
+
Obfuscar 路径转换只适用于 Git Bash/MSYS/Cygwin。macOS/Linux 的 `/Users`、`/usr` 等绝对路径直接传给工具;Windows 优先 `cygpath`,无该命令时只转换完整盘符根路径。修复后使用隔离副本验证五个 DLL 和指纹,再重新执行一键脚本的 Full 与最终加密产物冒烟。
|
|
74
|
+
|
|
75
|
+
在线 AI MCP 的生产依赖和命令复制为完整、自足的运行快照,生产命令链接解析为真实文件,保留执行权限;损坏、越界及目录循环链接提前拒绝。临时构建目录清理后命令必须仍能运行,旧依赖不得残留;不放宽原制品门禁。
|
|
76
|
+
|
|
77
|
+
前端构建的 macOS 可用内存按有界 `vm_stat` 的真实页大小计算空闲页加可回收文件页,不叠加匿名非活动、压缩或预读页。解析失败和探针超时回退原生空闲量;Windows/Linux 保持原统计方式。启动预算、95% 暂停、90% 恢复及连续五秒稳定门禁不变,正式发布不能跳过保护;统计错误应修正探针,并保留共享服务。
|
|
78
|
+
|
|
79
|
+
后端:
|
|
80
|
+
|
|
81
|
+
- 使用当前仓库规定的 .NET SDK;
|
|
82
|
+
- 配置开发专用数据库/Redis/Mongo/对象存储;
|
|
83
|
+
- 先跑定向测试,再按资源允许程度执行更大构建;
|
|
84
|
+
- 不让本地调试连接生产写库。
|
|
85
|
+
|
|
86
|
+
前端:
|
|
87
|
+
|
|
88
|
+
- 使用仓库规定的 Node/npm/pnpm 版本;
|
|
89
|
+
- 复用已有 Vite 服务,不重复启动;
|
|
90
|
+
- `src/config.json` 的 `ApiBaseDev` 是默认值;本地 URL 可在 `#` 前用
|
|
91
|
+
`?OsClient=...&ApiBase=...` 以最高优先级覆盖 ApiBase 与租户;
|
|
92
|
+
- 多组 `ApiBase + OsClient` 并行时按组创建独立浏览器 Profile/进程或 Playwright context,不能在
|
|
93
|
+
同一同源 context 的多个 Page 中混测;
|
|
94
|
+
- 人工第二组至少使用无痕窗口,但多个 Chrome 无痕窗口可能共享临时会话,不能承担多组强隔离;
|
|
95
|
+
- 从线上页面读取 `window.__MICROI_RUNTIME_ENDPOINT__`;旧版无该对象时按 URL、window 全局、
|
|
96
|
+
同源状态、域名解析/成功请求逐级确认,禁止猜测;
|
|
97
|
+
- 本地页面成功不替代宿主 Token、OsClient、菜单权限和生产构建验收。
|
|
98
|
+
|
|
99
|
+
## 最小上线验收
|
|
100
|
+
|
|
101
|
+
- API liveness 200,readiness 200;依赖降级能在 readiness/日志中体现。
|
|
102
|
+
- Web 首屏、登录、退出、Token 刷新正常。
|
|
103
|
+
- 管理员与普通角色各验证一个菜单和数据权限。
|
|
104
|
+
- FormEngine 新增/编辑/查询,ApiEngine 调用正常。
|
|
105
|
+
- 公有/私有文件各上传、预览/下载一次,Range/HEAD 按需验证。
|
|
106
|
+
- Redis/Mongo/对象存储短暂不可用后可恢复,无永久死锁或静默丢失。
|
|
107
|
+
- 双节点同时触发同一 Job/消息,业务副作用仅一次。
|
|
108
|
+
- 发布中终止一个节点,其余节点继续服务;恢复节点不重复初始化。
|
|
109
|
+
- 回滚步骤和恢复点已实际验证或明确标记未验证。
|
|
@@ -1,133 +1,133 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: microi-docs-coverage
|
|
3
|
-
description: Microi 中文官网文档与 Skills 能力覆盖审计。用于全面分析 microi.doc/docs/doc 与 docs/case、核对官方能力和 V8 函数是否已进入 microi.skills、补充或重构 Skills、维护文档到 Skill 的责任映射,以及防止后续新增中文文档造成 AI 知识漏项。
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
> **Microi吾码基础规范(强制):** 任何 AI 模型与宿主每次新建或接续吾码任务,先完整读取 `../workspace-conventions/SKILL.md`,必须执行版本播报、`@microi.net/cli` 后台自动升级、Skills/MCP 同步和进度播报。安装与诊断读取 `../microi-codex-installer/SKILL.md`;更新失败延后重试,不阻断当前工作。
|
|
7
|
-
|
|
8
|
-
# Microi 中文官网文档与 Skills 覆盖审计
|
|
9
|
-
|
|
10
|
-
当任务涉及“官网有但 AI 不知道”“全面同步官方文档到 Skills”“核对所有
|
|
11
|
-
V8 函数”或新增、调整官方中文文档时,使用本 Skill。
|
|
12
|
-
|
|
13
|
-
创始人源码工作区中的平台功能还必须执行 [工作区基础规范](../workspace-conventions/SKILL.md)
|
|
14
|
-
的“平台功能四项同步检查”:本 Skill 负责文档与 AI 知识覆盖,不能替代官方应用包发布
|
|
15
|
-
或 MCP 能力验收。既有页面、Skill 或 MCP 已完整覆盖时记录依据,不重复创建同义内容。
|
|
16
|
-
|
|
17
|
-
## 范围与事实源
|
|
18
|
-
|
|
19
|
-
- 能力映射扫描 `microi.doc/docs/doc/**/*.md`,但排除受发版规则保护的
|
|
20
|
-
`microi.doc/docs/doc/about/update-log.md`;视觉与可读性审计还必须包含
|
|
21
|
-
`microi.doc/docs/case/**/*.md`。
|
|
22
|
-
- `index.md`、`apps.md`、`app-detail.md`、`profile.md`、`login.md` 与
|
|
23
|
-
`contact/index.md` 是由专用 Vue 组件承载的站点交互页,必须单独登记并按各自
|
|
24
|
-
页面契约验收,不能静默漏扫,也不能机械套用正文档排版。
|
|
25
|
-
- 不扫描、不手工维护 `microi.doc/docs/en/`;英文站由中文站统一翻译。
|
|
26
|
-
- `references/capability-map.md` 维护每篇中文文档的责任 Skill。
|
|
27
|
-
- 文档描述能力边界,当前源码、接口定义、组件清单和 MCP Schema 决定真实签名。
|
|
28
|
-
- 不把客户表名、业务字段、扩展数据库名称或示例返回字段误判为平台 API。
|
|
29
|
-
|
|
30
|
-
## 审计流程
|
|
31
|
-
|
|
32
|
-
1. 运行自动审计:
|
|
33
|
-
|
|
34
|
-
```powershell
|
|
35
|
-
node microi.skills/microi-docs-coverage/scripts/audit-doc-skill-coverage.mjs
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
2. 先解决“未映射文档”和“无效责任 Skill”。每篇中文文档都必须在能力映射中
|
|
39
|
-
有明确负责人;宣传、培训、FAQ 等非 API 页面也要标明信息型覆盖。
|
|
40
|
-
3. 查看“未覆盖 V8 API、其它具名 API、MCP 工具”。逐项回到中文文档和
|
|
41
|
-
当前源码确认:
|
|
42
|
-
- 真实平台 API:补到对应 Skill 或 `v8-utilities` 索引。
|
|
43
|
-
- 业务数据路径:归一为 `V8.Form`、`V8.Param` 等上下文对象。
|
|
44
|
-
- 动态扩展名:归一为 `V8.Dbs`,不要固化客户数据库名称。
|
|
45
|
-
- 文档旧名或错误:以源码为准,说明兼容边界;不要为让审计通过而虚构 API。
|
|
46
|
-
4. 把高频决策和最小安全示例写进 `SKILL.md`;完整方法表、平台差异、硬件/
|
|
47
|
-
部署验收写进 `references/`,保持渐进披露。
|
|
48
|
-
5. 更新 `references/capability-map.md`,重新运行审计,直到严格检查通过。
|
|
49
|
-
6. 对每个新增或改动的 Skill 运行 `skill-creator` 的 `quick_validate.py`,
|
|
50
|
-
再执行 `git diff --check` 和相对链接检查。
|
|
51
|
-
7. 修改已注册的后端内嵌知识时,运行
|
|
52
|
-
`node microi.skills/scripts/sync-embedded-skills.mjs <skill-name...>`,再带 `--check`
|
|
53
|
-
回读一致性;它只更新已在 `Microi.AI.csproj` 注册的快照,正文仍来自 canonical Skills。
|
|
54
|
-
修改渐进内容后先显式刷新本次 Skill 的校验清单,再按名称验证;全库检查发现历史漂移时
|
|
55
|
-
单独记录,禁止修改无关 Skill 的哈希来掩盖漏项。插件/CLI 使用现有构建器同步分发副本,
|
|
56
|
-
打包成功不等于已发布到用户安装渠道。
|
|
57
|
-
|
|
58
|
-
## 中文文档视觉与可读性契约(强制)
|
|
59
|
-
|
|
60
|
-
文档正确但密密麻麻仍属于未完成。修改 `microi.doc/docs/doc/**/*.md` 或
|
|
61
|
-
`microi.doc/docs/case/**/*.md` 时同时遵守:
|
|
62
|
-
|
|
63
|
-
- 正文使用清晰的 H1/H2/H3 层级和 80–90 字符左右的阅读宽度;连续长段落拆为短段、列表、对比表、步骤、流程或有语义的卡片。不要为了“丰富”把每句话都做成卡片。
|
|
64
|
-
- 首屏先回答“这是什么、有什么价值、怎么选择”,再展开原理和完整参数;长篇高级细节可使用可访问的 `details/summary` 渐进披露。
|
|
65
|
-
- 三个以上可比较能力优先使用表格或网格卡片;三步以上的依赖流程优先使用流程图/步骤带。图标必须帮助辨识,不能只作装饰噪声。
|
|
66
|
-
- 颜色至少区分主能力、成功、警告、风险,但正文对比度必须满足易读要求;不能只靠颜色表达状态。亮色、暗色、窄屏和 `prefers-reduced-motion` 都要有样式。
|
|
67
|
-
- 真实案例截图进入 `docs/public/images/...`,使用稳定英文文件名、有效 `alt` 和简短图注;图片不得代替关键文字说明,移动端不得横向撑破页面。
|
|
68
|
-
- 整站共同规则优先落在 VitePress 主题层 `mci-site.scss` / `doc-readable.scss`,页面独有展示放独立 SCSS;禁止为几十篇 Markdown 机械复制内联 `<style>`。
|
|
69
|
-
- 新页面可复用 `.mci-doc-grid`、`.mci-doc-card`、`.mci-doc-chip`;产品页需要独立视觉时使用页面 marker + `body:has(...)` 限定作用域,不能污染登录页、首页或英文生成页。
|
|
70
|
-
- 改动后运行 `npm run check:readability` 与 `npm run check:content`,再在真实浏览器至少检查一个桌面宽度和一个移动宽度,覆盖亮/暗主题、代码块、表格、图片、侧栏与锚点。
|
|
71
|
-
- `microi.doc/docs/en/` 由脚本生成,不手工同步样式化内容;日常文档工作继续禁止修改 `about/update-log.md`。
|
|
72
|
-
|
|
73
|
-
自动可读性检查只能阻止缺少 H1、超长连续文字块或整站主题契约丢失,不能证明页面真正好看。最终仍要查看渲染结果,不能用构建成功替代视觉验收。
|
|
74
|
-
|
|
75
|
-
全站任务必须进一步执行以下闭环,禁止把“扫描到若干 `/doc` 文件”等同于
|
|
76
|
-
“全部中文阅读页已完善”:
|
|
77
|
-
|
|
78
|
-
1. 在 `docs/.vitepress/theme/doc-visual-profiles.js` 为每个 `/doc` 与 `/case` 中文阅读页明确选择 `overview`、`guide`、`reference`、`policy` 或 `showcase`。新增、删除、移动文档时,页面清单与视觉档案必须同步闭环;专用站点交互页需显式登记为独立范围,英文路由不得进入该表。
|
|
79
|
-
2. 运行 `npm run audit:visual` 查看逐页报告。强制检查应覆盖唯一 H1、首屏引导、章节密度、连续正文、页面类型对应的表格/列表/代码/图片/提示/自定义布局、图片 `alt` 和主题契约;交付前应达到 0 条阻断和 0 条密度建议。
|
|
80
|
-
3. 中文样式若用 `html:lang(zh) { ... }` 包裹,根暗色选择器必须写成 `&.dark`,使 Sass 编译为 `html:lang(zh).dark`;写 `.dark` 会错误编译为后代选择器并导致暗色覆盖失效。所有自定义浅/暗背景都必须与前景、次要文字、边框成对切换,并用测试验证正文至少达到 WCAG AA 4.5:1。
|
|
81
|
-
4. 在浏览器遍历全部中文阅读路由(包括 `/doc` 与 `/case`),检查页面类型类、唯一 H1、页面级横向溢出和明显低对比文字;再从五种视觉类型各选代表页,覆盖桌面/移动与亮色/暗色截图。专用站点交互页按自身组件测试与代表截图验收。只有已登记范围全部通过,才可描述为“全站视觉验收完成”。
|
|
82
|
-
5. 静态脚本、Sass 编译、单元测试、VitePress 构建和浏览器截图是不同证据层。任何一层因资源保护或环境问题跳过,最终必须明确写出,不能用其它层替代。
|
|
83
|
-
|
|
84
|
-
## 自动审计能证明什么
|
|
85
|
-
|
|
86
|
-
脚本验证:
|
|
87
|
-
|
|
88
|
-
- 中文文档清单与责任映射闭环;
|
|
89
|
-
- 映射中没有已删除文档或不存在的 Skill;
|
|
90
|
-
- 文档出现的标准化 `V8.*` 名称至少在某个 Skill Markdown 中出现;
|
|
91
|
-
- 文档出现的 `System`、`DiyCommon`、`SqlFunc`、`SqlSubQuery`、
|
|
92
|
-
`V8ExtensionRegistry` 具名 API 至少在某个 Skill 中出现;
|
|
93
|
-
- 文档出现的 `microi_*` MCP 工具名至少在某个 Skill 中出现;
|
|
94
|
-
- 文档出现的平台 HTTP 路由和平台全局函数至少在某个 Skill 中出现;
|
|
95
|
-
- 当前前端组件清单中的全部 `Control` 已进入表单组件参考;
|
|
96
|
-
- `v8-print.js`、`ble/tsc.js`、`ble/esc.js` 的公开蓝牙入口和全部构建器方法,
|
|
97
|
-
已同时进入中文官方文档、蓝牙 Skills 与前端 Monaco API 提示;
|
|
98
|
-
- `diy.common.js`、`diy-form.vue`、`diy-table.vue` 仍真实调用
|
|
99
|
-
`initV8Print`,且三处挂载范围已写入官方文档与 Skill;
|
|
100
|
-
- 动态业务路径被单独列出,便于人工复核。
|
|
101
|
-
|
|
102
|
-
脚本不能证明:
|
|
103
|
-
|
|
104
|
-
- Skill 的语义、示例、安全约束一定正确;
|
|
105
|
-
- 文档本身没有过时;
|
|
106
|
-
- 浏览器、蓝牙设备、打印机、数据库或多节点部署已经实测。
|
|
107
|
-
|
|
108
|
-
因此每轮全面同步还要做源码核对和按风险分层的真实验收,不能只追求字符串
|
|
109
|
-
覆盖率。
|
|
110
|
-
|
|
111
|
-
## 补充内容的归属
|
|
112
|
-
|
|
113
|
-
- 前端通用 API、扫码、消息、表格/表单助手:`v8-utilities`、
|
|
114
|
-
`v8-frontend-events`。
|
|
115
|
-
- 蓝牙直连运行、连接与批量语义:
|
|
116
|
-
`v8-frontend-events/references/bluetooth-print.md`;TSC/ESC 源码方法与编码:
|
|
117
|
-
`v8-frontend-events/references/bluetooth-print-api.md`;服务端模板打印仍归
|
|
118
|
-
`print-engine`。
|
|
119
|
-
- 后端通用上下文、Method、Base64、加密:`v8-utilities`。
|
|
120
|
-
- 表单设计器和字段组件:`microi-form-engine`。
|
|
121
|
-
- 菜单、模块与页面入口:`module-engine`。
|
|
122
|
-
- 部署、运行、配置和升级:`microi-deployment`。
|
|
123
|
-
- Dos.ORM 与扩展数据库:`dos-orm`。
|
|
124
|
-
- 微服务/前端微应用:`microi-microservice`。
|
|
125
|
-
- 其它专项能力优先补到已有同名 Engine/V8 Skill,避免再建内容重叠的 Skill。
|
|
126
|
-
|
|
127
|
-
## 禁止事项
|
|
128
|
-
|
|
129
|
-
- 不复制整篇官网文档到一个巨型 Skill。
|
|
130
|
-
- 不用叶子方法同名匹配掩盖对象归属错误。
|
|
131
|
-
- 不把 `V8.Form.OrderNo`、`V8.Param.id` 等业务字段当成平台函数。
|
|
132
|
-
- 不为了本次普通补充修改版本更新日志、英文文档或 Skills 版本清单。
|
|
133
|
-
- 不声称静态审计等于真实硬件、浏览器、远端或生产验收。
|
|
1
|
+
---
|
|
2
|
+
name: microi-docs-coverage
|
|
3
|
+
description: Microi 中文官网文档与 Skills 能力覆盖审计。用于全面分析 microi.doc/docs/doc 与 docs/case、核对官方能力和 V8 函数是否已进入 microi.skills、补充或重构 Skills、维护文档到 Skill 的责任映射,以及防止后续新增中文文档造成 AI 知识漏项。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
> **Microi吾码基础规范(强制):** 任何 AI 模型与宿主每次新建或接续吾码任务,先完整读取 `../workspace-conventions/SKILL.md`,必须执行版本播报、`@microi.net/cli` 后台自动升级、Skills/MCP 同步和进度播报。安装与诊断读取 `../microi-codex-installer/SKILL.md`;更新失败延后重试,不阻断当前工作。
|
|
7
|
+
|
|
8
|
+
# Microi 中文官网文档与 Skills 覆盖审计
|
|
9
|
+
|
|
10
|
+
当任务涉及“官网有但 AI 不知道”“全面同步官方文档到 Skills”“核对所有
|
|
11
|
+
V8 函数”或新增、调整官方中文文档时,使用本 Skill。
|
|
12
|
+
|
|
13
|
+
创始人源码工作区中的平台功能还必须执行 [工作区基础规范](../workspace-conventions/SKILL.md)
|
|
14
|
+
的“平台功能四项同步检查”:本 Skill 负责文档与 AI 知识覆盖,不能替代官方应用包发布
|
|
15
|
+
或 MCP 能力验收。既有页面、Skill 或 MCP 已完整覆盖时记录依据,不重复创建同义内容。
|
|
16
|
+
|
|
17
|
+
## 范围与事实源
|
|
18
|
+
|
|
19
|
+
- 能力映射扫描 `microi.doc/docs/doc/**/*.md`,但排除受发版规则保护的
|
|
20
|
+
`microi.doc/docs/doc/about/update-log.md`;视觉与可读性审计还必须包含
|
|
21
|
+
`microi.doc/docs/case/**/*.md`。
|
|
22
|
+
- `index.md`、`apps.md`、`app-detail.md`、`profile.md`、`login.md` 与
|
|
23
|
+
`contact/index.md` 是由专用 Vue 组件承载的站点交互页,必须单独登记并按各自
|
|
24
|
+
页面契约验收,不能静默漏扫,也不能机械套用正文档排版。
|
|
25
|
+
- 不扫描、不手工维护 `microi.doc/docs/en/`;英文站由中文站统一翻译。
|
|
26
|
+
- `references/capability-map.md` 维护每篇中文文档的责任 Skill。
|
|
27
|
+
- 文档描述能力边界,当前源码、接口定义、组件清单和 MCP Schema 决定真实签名。
|
|
28
|
+
- 不把客户表名、业务字段、扩展数据库名称或示例返回字段误判为平台 API。
|
|
29
|
+
|
|
30
|
+
## 审计流程
|
|
31
|
+
|
|
32
|
+
1. 运行自动审计:
|
|
33
|
+
|
|
34
|
+
```powershell
|
|
35
|
+
node microi.skills/microi-docs-coverage/scripts/audit-doc-skill-coverage.mjs
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
2. 先解决“未映射文档”和“无效责任 Skill”。每篇中文文档都必须在能力映射中
|
|
39
|
+
有明确负责人;宣传、培训、FAQ 等非 API 页面也要标明信息型覆盖。
|
|
40
|
+
3. 查看“未覆盖 V8 API、其它具名 API、MCP 工具”。逐项回到中文文档和
|
|
41
|
+
当前源码确认:
|
|
42
|
+
- 真实平台 API:补到对应 Skill 或 `v8-utilities` 索引。
|
|
43
|
+
- 业务数据路径:归一为 `V8.Form`、`V8.Param` 等上下文对象。
|
|
44
|
+
- 动态扩展名:归一为 `V8.Dbs`,不要固化客户数据库名称。
|
|
45
|
+
- 文档旧名或错误:以源码为准,说明兼容边界;不要为让审计通过而虚构 API。
|
|
46
|
+
4. 把高频决策和最小安全示例写进 `SKILL.md`;完整方法表、平台差异、硬件/
|
|
47
|
+
部署验收写进 `references/`,保持渐进披露。
|
|
48
|
+
5. 更新 `references/capability-map.md`,重新运行审计,直到严格检查通过。
|
|
49
|
+
6. 对每个新增或改动的 Skill 运行 `skill-creator` 的 `quick_validate.py`,
|
|
50
|
+
再执行 `git diff --check` 和相对链接检查。
|
|
51
|
+
7. 修改已注册的后端内嵌知识时,运行
|
|
52
|
+
`node microi.skills/scripts/sync-embedded-skills.mjs <skill-name...>`,再带 `--check`
|
|
53
|
+
回读一致性;它只更新已在 `Microi.AI.csproj` 注册的快照,正文仍来自 canonical Skills。
|
|
54
|
+
修改渐进内容后先显式刷新本次 Skill 的校验清单,再按名称验证;全库检查发现历史漂移时
|
|
55
|
+
单独记录,禁止修改无关 Skill 的哈希来掩盖漏项。插件/CLI 使用现有构建器同步分发副本,
|
|
56
|
+
打包成功不等于已发布到用户安装渠道。
|
|
57
|
+
|
|
58
|
+
## 中文文档视觉与可读性契约(强制)
|
|
59
|
+
|
|
60
|
+
文档正确但密密麻麻仍属于未完成。修改 `microi.doc/docs/doc/**/*.md` 或
|
|
61
|
+
`microi.doc/docs/case/**/*.md` 时同时遵守:
|
|
62
|
+
|
|
63
|
+
- 正文使用清晰的 H1/H2/H3 层级和 80–90 字符左右的阅读宽度;连续长段落拆为短段、列表、对比表、步骤、流程或有语义的卡片。不要为了“丰富”把每句话都做成卡片。
|
|
64
|
+
- 首屏先回答“这是什么、有什么价值、怎么选择”,再展开原理和完整参数;长篇高级细节可使用可访问的 `details/summary` 渐进披露。
|
|
65
|
+
- 三个以上可比较能力优先使用表格或网格卡片;三步以上的依赖流程优先使用流程图/步骤带。图标必须帮助辨识,不能只作装饰噪声。
|
|
66
|
+
- 颜色至少区分主能力、成功、警告、风险,但正文对比度必须满足易读要求;不能只靠颜色表达状态。亮色、暗色、窄屏和 `prefers-reduced-motion` 都要有样式。
|
|
67
|
+
- 真实案例截图进入 `docs/public/images/...`,使用稳定英文文件名、有效 `alt` 和简短图注;图片不得代替关键文字说明,移动端不得横向撑破页面。
|
|
68
|
+
- 整站共同规则优先落在 VitePress 主题层 `mci-site.scss` / `doc-readable.scss`,页面独有展示放独立 SCSS;禁止为几十篇 Markdown 机械复制内联 `<style>`。
|
|
69
|
+
- 新页面可复用 `.mci-doc-grid`、`.mci-doc-card`、`.mci-doc-chip`;产品页需要独立视觉时使用页面 marker + `body:has(...)` 限定作用域,不能污染登录页、首页或英文生成页。
|
|
70
|
+
- 改动后运行 `npm run check:readability` 与 `npm run check:content`,再在真实浏览器至少检查一个桌面宽度和一个移动宽度,覆盖亮/暗主题、代码块、表格、图片、侧栏与锚点。
|
|
71
|
+
- `microi.doc/docs/en/` 由脚本生成,不手工同步样式化内容;日常文档工作继续禁止修改 `about/update-log.md`。
|
|
72
|
+
|
|
73
|
+
自动可读性检查只能阻止缺少 H1、超长连续文字块或整站主题契约丢失,不能证明页面真正好看。最终仍要查看渲染结果,不能用构建成功替代视觉验收。
|
|
74
|
+
|
|
75
|
+
全站任务必须进一步执行以下闭环,禁止把“扫描到若干 `/doc` 文件”等同于
|
|
76
|
+
“全部中文阅读页已完善”:
|
|
77
|
+
|
|
78
|
+
1. 在 `docs/.vitepress/theme/doc-visual-profiles.js` 为每个 `/doc` 与 `/case` 中文阅读页明确选择 `overview`、`guide`、`reference`、`policy` 或 `showcase`。新增、删除、移动文档时,页面清单与视觉档案必须同步闭环;专用站点交互页需显式登记为独立范围,英文路由不得进入该表。
|
|
79
|
+
2. 运行 `npm run audit:visual` 查看逐页报告。强制检查应覆盖唯一 H1、首屏引导、章节密度、连续正文、页面类型对应的表格/列表/代码/图片/提示/自定义布局、图片 `alt` 和主题契约;交付前应达到 0 条阻断和 0 条密度建议。
|
|
80
|
+
3. 中文样式若用 `html:lang(zh) { ... }` 包裹,根暗色选择器必须写成 `&.dark`,使 Sass 编译为 `html:lang(zh).dark`;写 `.dark` 会错误编译为后代选择器并导致暗色覆盖失效。所有自定义浅/暗背景都必须与前景、次要文字、边框成对切换,并用测试验证正文至少达到 WCAG AA 4.5:1。
|
|
81
|
+
4. 在浏览器遍历全部中文阅读路由(包括 `/doc` 与 `/case`),检查页面类型类、唯一 H1、页面级横向溢出和明显低对比文字;再从五种视觉类型各选代表页,覆盖桌面/移动与亮色/暗色截图。专用站点交互页按自身组件测试与代表截图验收。只有已登记范围全部通过,才可描述为“全站视觉验收完成”。
|
|
82
|
+
5. 静态脚本、Sass 编译、单元测试、VitePress 构建和浏览器截图是不同证据层。任何一层因资源保护或环境问题跳过,最终必须明确写出,不能用其它层替代。
|
|
83
|
+
|
|
84
|
+
## 自动审计能证明什么
|
|
85
|
+
|
|
86
|
+
脚本验证:
|
|
87
|
+
|
|
88
|
+
- 中文文档清单与责任映射闭环;
|
|
89
|
+
- 映射中没有已删除文档或不存在的 Skill;
|
|
90
|
+
- 文档出现的标准化 `V8.*` 名称至少在某个 Skill Markdown 中出现;
|
|
91
|
+
- 文档出现的 `System`、`DiyCommon`、`SqlFunc`、`SqlSubQuery`、
|
|
92
|
+
`V8ExtensionRegistry` 具名 API 至少在某个 Skill 中出现;
|
|
93
|
+
- 文档出现的 `microi_*` MCP 工具名至少在某个 Skill 中出现;
|
|
94
|
+
- 文档出现的平台 HTTP 路由和平台全局函数至少在某个 Skill 中出现;
|
|
95
|
+
- 当前前端组件清单中的全部 `Control` 已进入表单组件参考;
|
|
96
|
+
- `v8-print.js`、`ble/tsc.js`、`ble/esc.js` 的公开蓝牙入口和全部构建器方法,
|
|
97
|
+
已同时进入中文官方文档、蓝牙 Skills 与前端 Monaco API 提示;
|
|
98
|
+
- `diy.common.js`、`diy-form.vue`、`diy-table.vue` 仍真实调用
|
|
99
|
+
`initV8Print`,且三处挂载范围已写入官方文档与 Skill;
|
|
100
|
+
- 动态业务路径被单独列出,便于人工复核。
|
|
101
|
+
|
|
102
|
+
脚本不能证明:
|
|
103
|
+
|
|
104
|
+
- Skill 的语义、示例、安全约束一定正确;
|
|
105
|
+
- 文档本身没有过时;
|
|
106
|
+
- 浏览器、蓝牙设备、打印机、数据库或多节点部署已经实测。
|
|
107
|
+
|
|
108
|
+
因此每轮全面同步还要做源码核对和按风险分层的真实验收,不能只追求字符串
|
|
109
|
+
覆盖率。
|
|
110
|
+
|
|
111
|
+
## 补充内容的归属
|
|
112
|
+
|
|
113
|
+
- 前端通用 API、扫码、消息、表格/表单助手:`v8-utilities`、
|
|
114
|
+
`v8-frontend-events`。
|
|
115
|
+
- 蓝牙直连运行、连接与批量语义:
|
|
116
|
+
`v8-frontend-events/references/bluetooth-print.md`;TSC/ESC 源码方法与编码:
|
|
117
|
+
`v8-frontend-events/references/bluetooth-print-api.md`;服务端模板打印仍归
|
|
118
|
+
`print-engine`。
|
|
119
|
+
- 后端通用上下文、Method、Base64、加密:`v8-utilities`。
|
|
120
|
+
- 表单设计器和字段组件:`microi-form-engine`。
|
|
121
|
+
- 菜单、模块与页面入口:`module-engine`。
|
|
122
|
+
- 部署、运行、配置和升级:`microi-deployment`。
|
|
123
|
+
- Dos.ORM 与扩展数据库:`dos-orm`。
|
|
124
|
+
- 微服务/前端微应用:`microi-microservice`。
|
|
125
|
+
- 其它专项能力优先补到已有同名 Engine/V8 Skill,避免再建内容重叠的 Skill。
|
|
126
|
+
|
|
127
|
+
## 禁止事项
|
|
128
|
+
|
|
129
|
+
- 不复制整篇官网文档到一个巨型 Skill。
|
|
130
|
+
- 不用叶子方法同名匹配掩盖对象归属错误。
|
|
131
|
+
- 不把 `V8.Form.OrderNo`、`V8.Param.id` 等业务字段当成平台函数。
|
|
132
|
+
- 不为了本次普通补充修改版本更新日志、英文文档或 Skills 版本清单。
|
|
133
|
+
- 不声称静态审计等于真实硬件、浏览器、远端或生产验收。
|