docs: references - add architecture evidence contracts

This commit is contained in:
tradecatlabs
2026-06-01 23:43:24 +08:00
parent 2e2743da34
commit 890116ada3
8 changed files with 55 additions and 31 deletions
+3 -3
View File
@@ -70,7 +70,7 @@ git push origin develop
| `make check-directory-docs` | 校验仓库自有目录 README/AGENTS 覆盖 | Python 3 | | `make check-directory-docs` | 校验仓库自有目录 README/AGENTS 覆盖 | Python 3 |
| `make check-metadata` | 校验 metadata 路径与锚点 | Python 3 | | `make check-metadata` | 校验 metadata 路径与锚点 | Python 3 |
| `make check-ai-citation` | 校验 llms 与 AI 引用语料路径和锚点 | Python 3 | | `make check-ai-citation` | 校验 llms 与 AI 引用语料路径和锚点 | Python 3 |
| `make check-modern-architecture-kit` | 校验现代企业数字化平台 starter kit 的 19 组 schema、示例和跨文件一致性 | Python 3 | | `make check-modern-architecture-kit` | 校验现代企业数字化平台 starter kit 的 25 组 schema、示例和跨文件一致性 | Python 3 |
| `make check-wiki WIKI_DIR=/tmp/vibe-coding-cn.wiki` | 校验 GitHub Wiki 独立仓库本地 checkout 的页面覆盖、内链、旧口径和 Markdown | Python 3、Node.js 22+、本地 Wiki checkout | | `make check-wiki WIKI_DIR=/tmp/vibe-coding-cn.wiki` | 校验 GitHub Wiki 独立仓库本地 checkout 的页面覆盖、内链、旧口径和 Markdown | Python 3、Node.js 22+、本地 Wiki checkout |
| `make sync-doc-toc` | 兼容旧线性 README 目录生成;当前拆分结构下通常无变更 | Python 3 | | `make sync-doc-toc` | 兼容旧线性 README 目录生成;当前拆分结构下通常无变更 | Python 3 |
| `make test` | 执行本地质量门禁 | Node.js 22+、Python 3 | | `make test` | 执行本地质量门禁 | Node.js 22+、Python 3 |
@@ -233,14 +233,14 @@ git push origin develop
- `scripts/check-directory-docs.py` - 仓库自有目录 README/AGENTS 覆盖检查脚本,供 `make check-directory-docs` 与 CI 使用 - `scripts/check-directory-docs.py` - 仓库自有目录 README/AGENTS 覆盖检查脚本,供 `make check-directory-docs` 与 CI 使用
- `scripts/check-metadata.py` - metadata 路径与锚点检查脚本,供 `make check-metadata` 与 CI 使用 - `scripts/check-metadata.py` - metadata 路径与锚点检查脚本,供 `make check-metadata` 与 CI 使用
- `scripts/check-ai-citation.py` - llms 与 AI 引用语料路径和锚点检查脚本,供 `make check-ai-citation` 与 CI 使用 - `scripts/check-ai-citation.py` - llms 与 AI 引用语料路径和锚点检查脚本,供 `make check-ai-citation` 与 CI 使用
- `scripts/check-modern-architecture-kit.py` - 现代企业数字化平台 starter kit 的 19 组 schema、示例和跨文件一致性检查脚本,供 `make check-modern-architecture-kit` 与 CI 使用 - `scripts/check-modern-architecture-kit.py` - 现代企业数字化平台 starter kit 的 25 组 schema、示例和跨文件一致性检查脚本,供 `make check-modern-architecture-kit` 与 CI 使用
- `scripts/check-wiki.py` - GitHub Wiki 独立仓库本地 checkout 页面覆盖、内链和旧口径检查脚本,供 `make check-wiki` 使用 - `scripts/check-wiki.py` - GitHub Wiki 独立仓库本地 checkout 页面覆盖、内链和旧口径检查脚本,供 `make check-wiki` 使用
- `scripts/sync-doc-toc.py` - docs README 细粒度目录兼容脚本,当前拆分结构下通常无变更,供 `make sync-doc-toc` 使用 - `scripts/sync-doc-toc.py` - docs README 细粒度目录兼容脚本,当前拆分结构下通常无变更,供 `make sync-doc-toc` 使用
- `tools/prompts-library/main.py` - 提示词转换工具入口 - `tools/prompts-library/main.py` - 提示词转换工具入口
- `docs/getting-started/README.md` - 从零开始索引入口,正文拆分到学习地图、Vibe Coding 经验、网络配置、CLI 配置与开发环境搭建 - `docs/getting-started/README.md` - 从零开始索引入口,正文拆分到学习地图、Vibe Coding 经验、网络配置、CLI 配置与开发环境搭建
- `docs/concepts/problem-solving.md` - 问题定义与求解路径底层模型 - `docs/concepts/problem-solving.md` - 问题定义与求解路径底层模型
- `docs/references/project-architecture-template.md` - 常见项目结构、架构设计原则、最低门禁和检查清单 - `docs/references/project-architecture-template.md` - 常见项目结构、架构设计原则、最低门禁和检查清单
- `docs/references/modern-enterprise-architecture-kit/README.md` - 现代企业数字化平台 V2.2 starter kit、schema、示例和一致性校验入口 - `docs/references/modern-enterprise-architecture-kit/README.md` - 现代企业数字化平台 V2.3 starter kit、schema、示例和一致性校验入口
- `docs/references/technology-stack.md` - 常见软件系统技术栈、选型维度、组合案例与初学者学习路径 - `docs/references/technology-stack.md` - 常见软件系统技术栈、选型维度、组合案例与初学者学习路径
- `skills/auto-skill/` - Skills 生成、重构与校验的元技能 - `skills/auto-skill/` - Skills 生成、重构与校验的元技能
- `skills/auto-tmux/` - tmux 自动化操控、脚本化 pane 巡检、按键注入、日志录制与多终端协作技能 - `skills/auto-tmux/` - tmux 自动化操控、脚本化 pane 巡检、按键注入、日志录制与多终端协作技能
+1 -1
View File
@@ -68,7 +68,7 @@ GEOFlow 的关键启发是:GEO 不是关键词堆砌,而是内容工程链
- docs/references/python-project-skeleton.mdPython 应用、服务、脚本工具和库项目的通用骨架。 - docs/references/python-project-skeleton.mdPython 应用、服务、脚本工具和库项目的通用骨架。
- docs/references/enterprise-architecture-template.md:中大型工程组织、平台工程和多产品线参考模型。 - docs/references/enterprise-architecture-template.md:中大型工程组织、平台工程和多产品线参考模型。
- docs/references/modern-enterprise-architecture-template.md:面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。 - docs/references/modern-enterprise-architecture-template.md:面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
- docs/references/modern-enterprise-architecture-kit/README.md:现代企业数字化平台 V2.219 组 schema、YAML 示例、嵌套约束和跨文件一致性校验入口。 - docs/references/modern-enterprise-architecture-kit/README.md:现代企业数字化平台 V2.325 组 schema、YAML 示例、证据链字段和跨文件一致性校验入口。
- docs/references/dataset-first-data-service.md:以 dataset、contract、registry、runtime 为核心的数据服务模板。 - docs/references/dataset-first-data-service.md:以 dataset、contract、registry、runtime 为核心的数据服务模板。
- docs/references/code-organization.md:模块化、命名、注释、格式化、文档和工具。 - docs/references/code-organization.md:模块化、命名、注释、格式化、文档和工具。
- docs/references/development-experience.md:变量名、文件结构、编码规范、架构原则和常见基础设施经验。 - docs/references/development-experience.md:变量名、文件结构、编码规范、架构原则和常见基础设施经验。
+1 -1
View File
@@ -63,7 +63,7 @@
- [通用 Python 项目骨架](./references/python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。 - [通用 Python 项目骨架](./references/python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。
- [企业级架构模板](./references/enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。 - [企业级架构模板](./references/enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。
- [现代企业数字化平台架构](./references/modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。 - [现代企业数字化平台架构](./references/modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
- [现代企业数字化平台 Starter Kit](./references/modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.219 组 schema、YAML 示例、嵌套约束和跨文件一致性校验入口。 - [现代企业数字化平台 Starter Kit](./references/modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.325 组 schema、YAML 示例、证据链字段和跨文件一致性校验入口。
- [Dataset First 数据服务](./references/dataset-first-data-service.md) - 数据服务模板。 - [Dataset First 数据服务](./references/dataset-first-data-service.md) - 数据服务模板。
- [代码组织](./references/code-organization.md) - 模块化、命名、注释、格式化、文档和工具。 - [代码组织](./references/code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
- [开发经验](./references/development-experience.md) - 编码规范、架构原则和常见基础设施经验。 - [开发经验](./references/development-experience.md) - 编码规范、架构原则和常见基础设施经验。
+1 -1
View File
@@ -20,7 +20,7 @@ references/
├── python-project-skeleton.md ├── python-project-skeleton.md
├── enterprise-architecture-template.md ├── enterprise-architecture-template.md
├── modern-enterprise-architecture-template.md # 现代企业数字化平台、版本治理、可执行标准、RACI、可靠性分级、仓库拓扑、迁移弃用、审计证据、微服务容器 GitOps、AI 原生能力、供应链安全和联邦治理蓝图 ├── modern-enterprise-architecture-template.md # 现代企业数字化平台、版本治理、可执行标准、RACI、可靠性分级、仓库拓扑、迁移弃用、审计证据、微服务容器 GitOps、AI 原生能力、供应链安全和联邦治理蓝图
├── modern-enterprise-architecture-kit/ # 现代企业数字化平台 V2.2 starter kit、schema、示例和一致性校验 ├── modern-enterprise-architecture-kit/ # 现代企业数字化平台 V2.3 starter kit、schema、示例和一致性校验
├── dataset-first-data-service.md ├── dataset-first-data-service.md
├── code-organization.md ├── code-organization.md
├── development-experience.md ├── development-experience.md
+2 -2
View File
@@ -15,7 +15,7 @@
| <a id="reference-engineering-practice-通用-python-项目骨架"></a>[通用 Python 项目骨架](python-project-skeleton.md) | Python 应用、服务、脚本工具和库项目的通用骨架。 | | <a id="reference-engineering-practice-通用-python-项目骨架"></a>[通用 Python 项目骨架](python-project-skeleton.md) | Python 应用、服务、脚本工具和库项目的通用骨架。 |
| <a id="reference-engineering-practice-enterprise-monorepo-multi-repo-reference-architecture-template"></a>[企业级 Monorepo / Multi-repo 架构模板](enterprise-architecture-template.md) | 中大型工程组织、平台工程和多产品线参考模型。 | | <a id="reference-engineering-practice-enterprise-monorepo-multi-repo-reference-architecture-template"></a>[企业级 Monorepo / Multi-repo 架构模板](enterprise-architecture-template.md) | 中大型工程组织、平台工程和多产品线参考模型。 |
| <a id="reference-modern-enterprise-architecture-template"></a>[现代企业数字化平台架构](modern-enterprise-architecture-template.md) | 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。 | | <a id="reference-modern-enterprise-architecture-template"></a>[现代企业数字化平台架构](modern-enterprise-architecture-template.md) | 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。 |
| <a id="reference-modern-enterprise-architecture-kit"></a>[现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) | 现代企业数字化平台 V2.219 组 schema、YAML 示例、嵌套约束和跨文件一致性校验入口。 | | <a id="reference-modern-enterprise-architecture-kit"></a>[现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) | 现代企业数字化平台 V2.325 组 schema、YAML 示例、证据链字段和跨文件一致性校验入口。 |
| <a id="reference-engineering-practice-7-dataset-first-数据服务结构"></a>[Dataset First 数据服务结构](dataset-first-data-service.md) | 以 dataset、contract、registry、runtime 为核心的数据服务模板。 | | <a id="reference-engineering-practice-7-dataset-first-数据服务结构"></a>[Dataset First 数据服务结构](dataset-first-data-service.md) | 以 dataset、contract、registry、runtime 为核心的数据服务模板。 |
| <a id="reference-engineering-practice-2-代码组织"></a>[代码组织](code-organization.md) | 模块化、命名、注释、格式化、文档和工具。 | | <a id="reference-engineering-practice-2-代码组织"></a>[代码组织](code-organization.md) | 模块化、命名、注释、格式化、文档和工具。 |
| <a id="reference-engineering-practice-3-开发经验"></a>[开发经验](development-experience.md) | 变量名、文件结构、编码规范、架构原则和常见基础设施经验。 | | <a id="reference-engineering-practice-3-开发经验"></a>[开发经验](development-experience.md) | 变量名、文件结构、编码规范、架构原则和常见基础设施经验。 |
@@ -35,7 +35,7 @@
- [通用 Python 项目骨架](python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。 - [通用 Python 项目骨架](python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。
- [企业级 Monorepo / Multi-repo 架构模板](enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。 - [企业级 Monorepo / Multi-repo 架构模板](enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。
- [现代企业数字化平台架构](modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。 - [现代企业数字化平台架构](modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
- [现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.219 组 schema、YAML 示例、嵌套约束和跨文件一致性校验入口。 - [现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.325 组 schema、YAML 示例、证据链字段和跨文件一致性校验入口。
- [Dataset First 数据服务结构](dataset-first-data-service.md) - 以 dataset、contract、registry、runtime 为核心的数据服务模板。 - [Dataset First 数据服务结构](dataset-first-data-service.md) - 以 dataset、contract、registry、runtime 为核心的数据服务模板。
- [代码组织](code-organization.md) - 模块化、命名、注释、格式化、文档和工具。 - [代码组织](code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
- [开发经验](development-experience.md) - 变量名、文件结构、编码规范、架构原则和常见基础设施经验。 - [开发经验](development-experience.md) - 变量名、文件结构、编码规范、架构原则和常见基础设施经验。
@@ -1,10 +1,10 @@
# 现代企业数字化平台架构说明文档 # 现代企业数字化平台架构说明文档
**文档版本**V2.2 **文档版本**V2.3
**适用对象**:企业管理层、产品负责人、架构师、研发负责人、数据负责人、平台团队、安全合规团队 **适用对象**:企业管理层、产品负责人、架构师、研发负责人、数据负责人、平台团队、安全合规团队
**适用范围**:中大型企业数字化平台建设、业务系统重构、平台工程建设、数据产品化、组织协同机制设计 **适用范围**:中大型企业数字化平台建设、业务系统重构、平台工程建设、数据产品化、组织协同机制设计
**文档定位**:本文件用于说明现代企业数字化平台的总体架构、核心组成、团队职责、治理机制、技术原则和落地路径。 **文档定位**:本文件用于说明现代企业数字化平台的总体架构、核心组成、团队职责、治理机制、技术原则和落地路径。
**专项修订**V2.2 在 V2.1 基础上补齐 API、事件、AI 工具、RAG、微调、GitOps、catalog 和 scorecard 的 starter kit 契约。 **专项修订**V2.3 在 V2.2 基础上补齐发布证据、供应链证明、治理例外、兼容性报告和 GitOps 漂移报告的 starter kit 契约。
--- ---
@@ -52,7 +52,7 @@
| 版本 | 状态 | 说明 | | 版本 | 状态 | 说明 |
| ---- | ---- | ---- | | ---- | ---- | ---- |
| `V2.2` | `Baseline Candidate` | 用作可执行企业标准起点;包含 19 组 starter kit schema/example、跨文件一致性和自动化校验入口 | | `V2.3` | `Baseline Candidate` | 用作可执行企业标准起点;包含 25 组 starter kit schema/example、证据链一致性和自动化校验入口 |
### 0.3 变更分级 ### 0.3 变更分级
@@ -110,12 +110,13 @@ git diff --check
| `V2.0` | 2026-06-01 | Major | 新增可执行 starter kit、JSON Schema、YAML 示例和自动化校验入口 | | `V2.0` | 2026-06-01 | Major | 新增可执行 starter kit、JSON Schema、YAML 示例和自动化校验入口 |
| `V2.1` | 2026-06-01 | Minor | 增强 starter kit schema 嵌套约束、格式校验、跨文件一致性检查和 CI 门禁口径 | | `V2.1` | 2026-06-01 | Minor | 增强 starter kit schema 嵌套约束、格式校验、跨文件一致性检查和 CI 门禁口径 |
| `V2.2` | 2026-06-01 | Minor | 补齐 API、事件、AI 工具、RAG、微调、GitOps、catalog 和 scorecard 契约模板 | | `V2.2` | 2026-06-01 | Minor | 补齐 API、事件、AI 工具、RAG、微调、GitOps、catalog 和 scorecard 契约模板 |
| `V2.3` | 2026-06-01 | Minor | 补齐发布证据、供应链证明、治理例外、API/Event 兼容性报告和 GitOps 漂移报告契约模板 |
### 0.7 V2.2 可执行企业标准路线图 ### 0.7 V2.3 可执行企业标准路线图
V2.0 已将 V1.9 的文档化基线转化为第一批可执行资产。V2.1 继续把字段约束、示例一致性和远程 CI 门禁补强为可执行口径。V2.2 把主文档最小验证包中的 API、事件、AI 工具、RAG、微调、GitOps、catalog 和 scorecard 纳入 schema/example 校验。后续 `V2.x` 迭代应继续补充示例仓库,并把平台、catalog、GitOps 和审计系统连接起来。 V2.0 已将 V1.9 的文档化基线转化为第一批可执行资产。V2.1 继续把字段约束、示例一致性和远程 CI 门禁补强为可执行口径。V2.2 把主文档最小验证包中的 API、事件、AI 工具、RAG、微调、GitOps、catalog 和 scorecard 纳入 schema/example 校验。V2.3 继续把发布证据、供应链证明、治理例外、兼容性报告和 GitOps 漂移报告纳入机器可校验基线。后续 `V2.x` 迭代应继续补充示例仓库,并把平台、catalog、GitOps 和审计系统连接起来。
V2.2 起点包括: V2.3 起点包括:
1. 真相源字段矩阵:明确 `domain.yaml``service.yaml``ai-product.yaml``data-product.yaml`、catalog、GitOps 和 runtime 的字段权威。 1. 真相源字段矩阵:明确 `domain.yaml``service.yaml``ai-product.yaml``data-product.yaml`、catalog、GitOps 和 runtime 的字段权威。
2. 契约模板:提供服务、领域、数据产品、AI 产品、Agent 工具、RAG、微调、GitOps 和生产就绪模板。 2. 契约模板:提供服务、领域、数据产品、AI 产品、Agent 工具、RAG、微调、GitOps 和生产就绪模板。
@@ -125,7 +126,7 @@ V2.2 起点包括:
6. 可靠性分级:补齐 Tier-1 / Tier-2 / Tier-3、RTO、RPO、灾备演练、错误预算和 on-call 升级路径。 6. 可靠性分级:补齐 Tier-1 / Tier-2 / Tier-3、RTO、RPO、灾备演练、错误预算和 on-call 升级路径。
7. 迁移与弃用:定义旧系统绞杀迁移、API 版本弃用、数据产品兼容、AI 模型退役和平台能力下线流程。 7. 迁移与弃用:定义旧系统绞杀迁移、API 版本弃用、数据产品兼容、AI 模型退役和平台能力下线流程。
8. 验证包:提供 `make test`、schema 校验、示例仓库和审计证据清单,证明标准可以落地执行。 8. 验证包:提供 `make test`、schema 校验、示例仓库和审计证据清单,证明标准可以落地执行。
9. Starter Kit:提供 `docs/references/modern-enterprise-architecture-kit/` 下的 19 组 schema/example、嵌套字段校验、格式校验和示例跨文件一致性检查。 9. Starter Kit:提供 `docs/references/modern-enterprise-architecture-kit/` 下的 25 组 schema/example、嵌套字段校验、格式校验、证据链验真字段和示例跨文件一致性检查。
--- ---
@@ -1501,7 +1502,11 @@ governance/
│ ├── deprecation-policy.md │ ├── deprecation-policy.md
│ └── compatibility-policy.md │ └── compatibility-policy.md
├── evidence/ ├── evidence/
│ ├── release-evidence-checklist.md │ ├── releases/
│ ├── supply-chain/
│ ├── exceptions/
│ ├── compatibility/
│ ├── drift/
│ ├── audit-evidence-index.md │ ├── audit-evidence-index.md
│ └── drill-evidence-template.md │ └── drill-evidence-template.md
├── risk-register/ ├── risk-register/
@@ -2396,7 +2401,11 @@ governance/architecture-gates/production-readiness.yaml
governance/ownership/raci.yaml governance/ownership/raci.yaml
governance/slo/tiering-policy.md governance/slo/tiering-policy.md
governance/migration/deprecation-policy.md governance/migration/deprecation-policy.md
governance/evidence/release-evidence-checklist.md governance/evidence/releases/{service-release}.yaml
governance/evidence/supply-chain/{service-attestation}.yaml
governance/evidence/exceptions/{policy-exception}.yaml
governance/evidence/compatibility/{api-or-event-report}.yaml
governance/evidence/drift/{service-drift-report}.yaml
infra/gitops/environments/dev/{domain}/{service}/kustomization.yaml infra/gitops/environments/dev/{domain}/{service}/kustomization.yaml
infra/gitops/environments/prod/{domain}/{service}/kustomization.yaml infra/gitops/environments/prod/{domain}/{service}/kustomization.yaml
``` ```
@@ -2518,7 +2527,7 @@ observability:
replayEnabled: true replayEnabled: true
``` ```
V2.2 starter kit 还提供以下可执行契约模板: V2.3 starter kit 还提供以下可执行契约模板:
1. `api-contract.yaml`API producer、consumer、auth、版本和兼容策略。 1. `api-contract.yaml`API producer、consumer、auth、版本和兼容策略。
2. `event-contract.yaml`:事件 topic、schema、幂等键、投递语义和消费者。 2. `event-contract.yaml`:事件 topic、schema、幂等键、投递语义和消费者。
@@ -2528,6 +2537,12 @@ V2.2 starter kit 还提供以下可执行契约模板:
6. `gitops-deployment.yaml`:环境、namespace、镜像 digest、资源、发布策略和供应链准入。 6. `gitops-deployment.yaml`:环境、namespace、镜像 digest、资源、发布策略和供应链准入。
7. `catalog-data-product.yaml``catalog-ai-product.yaml`catalog 指针、owner、生命周期和运行索引。 7. `catalog-data-product.yaml``catalog-ai-product.yaml`catalog 指针、owner、生命周期和运行索引。
8. `scorecard.yaml`:生产就绪、供应链、运行证据和复审周期。 8. `scorecard.yaml`:生产就绪、供应链、运行证据和复审周期。
9. `release-evidence.yaml`:发布版本、commit、GitOps revision、镜像 digest、catalog 指针、pipeline run、测试和批准证据。
10. `supply-chain-attestation.yaml`:构建来源、SLSA 等级、builder identity、SBOM、provenance、签名、证书、透明日志和验签命令。
11. `policy-exception.yaml`:治理例外、补偿控制、批准日期、到期日期、补救计划和过期自动阻断要求。
12. `api-compatibility-report.yaml`:API 版本兼容、消费者影响、breaking change 明细、豁免状态和发布决策。
13. `event-compatibility-report.yaml`:事件 Schema 兼容、消费者影响、重放要求、豁免状态和发布决策。
14. `gitops-drift-report.yaml`:GitOps 期望状态、运行观测状态、镜像/config/policy 漂移和发布阻断决策。
### 10.10.3 自动化门禁映射 ### 10.10.3 自动化门禁映射
@@ -2536,13 +2551,13 @@ V2.2 starter kit 还提供以下可执行契约模板:
| 阶段 | 自动化门禁 | 输入 | 阻断条件 | | 阶段 | 自动化门禁 | 输入 | 阻断条件 |
| ---- | ---------- | ---- | -------- | | ---- | ---------- | ---- | -------- |
| 提交 | Markdown、YAML、Schema、Policy 语法检查 | 文档、契约、策略文件 | 语法错误、坏链接、缺失必填字段 | | 提交 | Markdown、YAML、Schema、Policy 语法检查 | 文档、契约、策略文件 | 语法错误、坏链接、缺失必填字段 |
| Pull Request | API / Event / Data / AI 契约兼容性检查 | `contracts/``domains/``ai/` | breaking change 无消费者影响分析 | | Pull Request | API / Event / Data / AI 契约兼容性检查 | `contracts/``domains/``ai/`、兼容性报告 | breaking change 无消费者影响分析 |
| 构建 | 单元测试、依赖锁定、漏洞、许可证、密钥扫描 | 源码、锁文件、Dockerfile | 高危漏洞、未知许可证、密钥泄露 | | 构建 | 单元测试、依赖锁定、漏洞、许可证、密钥扫描 | 源码、锁文件、Dockerfile | 高危漏洞、未知许可证、密钥泄露 |
| 制品 | SBOM、provenance、镜像签名、基础镜像策略 | 镜像、构建日志、制品摘要 | 无 SBOM、无签名、来源不可证明 | | 制品 | SBOM、provenance、镜像签名、基础镜像策略 | 镜像、构建日志、制品摘要、供应链证明 | 无 SBOM、无签名、来源不可证明 |
| 发布 | GitOps diff、策略准入、资源配额、SLO 和 runbook 校验 | GitOps overlay、catalog、service.yaml | 无 owner、无 runbook、无 digest、资源未声明 | | 发布 | GitOps diff、策略准入、资源配额、SLO 和 runbook 校验 | GitOps overlay、catalog、service.yaml、发布证据 | 无 owner、无 runbook、无 digest、资源未声明 |
| AI 发布 | 评估集、红队、RAG 权限、工具权限、人工确认策略 | `ai-product.yaml``contracts/ai/` | 高风险工具无人工确认、评估未达标 | | AI 发布 | 评估集、红队、RAG 权限、工具权限、人工确认策略 | `ai-product.yaml``contracts/ai/` | 高风险工具无人工确认、评估未达标 |
| 数据发布 | schema、质量规则、权限、血缘、freshness 校验 | `data-product.yaml`、数据契约 | 无质量规则、无分级分类、无下游通知 | | 数据发布 | schema、质量规则、权限、血缘、freshness 校验 | `data-product.yaml`、数据契约 | 无质量规则、无分级分类、无下游通知 |
| 运行 | SLO、成本、漂移、异常调用、供应链策略漂移 | runtime、observability、audit | 错误预算耗尽、成本超预算、策略漂移 | | 运行 | SLO、成本、漂移、异常调用、供应链策略漂移 | runtime、observability、audit、漂移报告 | 错误预算耗尽、成本超预算、策略漂移 |
### 10.10.4 漂移检测规则 ### 10.10.4 漂移检测规则
@@ -2554,10 +2569,11 @@ V2.2 starter kit 还提供以下可执行契约模板:
2. catalog 指向的 GitOps 路径不存在,或 GitOps 路径指向的服务没有 catalog entry。 2. catalog 指向的 GitOps 路径不存在,或 GitOps 路径指向的服务没有 catalog entry。
3. GitOps 使用的镜像 tag 无法解析到不可变 digest。 3. GitOps 使用的镜像 tag 无法解析到不可变 digest。
4. 生产 Deployment 的镜像 digest 与 GitOps 期望状态不一致。 4. 生产 Deployment 的镜像 digest 与 GitOps 期望状态不一致。
5. Kubernetes runtime 存在未登记到 catalog 的长期运行工作负载 5. 生产 Deployment 的 ConfigMap / Secret hash、ServiceAccount、NetworkPolicy、Pod 安全策略或准入策略与 GitOps 期望状态不一致
6. 数据产品 schema 与实际表结构或数据契约不一致 6. Kubernetes runtime 存在未登记到 catalog 的长期运行工作负载
7. AI 产品运行中的 Prompt、模型、RAG 索引或工具版本与 `ai-product.yaml` 不一致。 7. 数据产品 schema 与实际表结构或数据契约不一致。
8. 策略例外超过到期时间仍在生产准入中生效 8. AI 产品运行中的 Prompt、模型、RAG 索引或工具版本与 `ai-product.yaml` 不一致
9. 策略例外超过到期时间仍在生产准入中生效。
漂移处理规则: 漂移处理规则:
@@ -2670,10 +2686,14 @@ docs/references/modern-enterprise-architecture-kit/
make check-modern-architecture-kit make check-modern-architecture-kit
``` ```
该命令是仓库内零依赖 starter gate,用于校验本仓库 19 组示例的 JSON Schema 子集、YAML 示例、嵌套必填字段、格式约束和示例间一致性。企业生产落地时应优先接入成熟校验器,例如 JSON Schema draft 2020-12 validator、YAML parser、OpenAPI / AsyncAPI checker、OPA / Cedar / Kyverno policy test 和 GitOps diff 工具;本仓库脚本只作为 starter kit 的最小可执行证明。 该命令是仓库内零依赖 starter gate,用于校验本仓库 25 组示例的 JSON Schema 子集、YAML 示例、嵌套必填字段、格式约束、证据链字段和示例间一致性。企业生产落地时应优先接入成熟校验器,例如 JSON Schema draft 2020-12 validator、YAML parser、OpenAPI / AsyncAPI checker、OPA / Cedar / Kyverno policy test、SLSA / Sigstore verifier 和 GitOps diff 工具;本仓库脚本只作为 starter kit 的最小可执行证明。
```text ```text
governance/evidence/release-evidence-checklist.md governance/evidence/releases/{service-release}.yaml
governance/evidence/supply-chain/{service-attestation}.yaml
governance/evidence/exceptions/{policy-exception}.yaml
governance/evidence/compatibility/{api-or-event-report}.yaml
governance/evidence/drift/{service-drift-report}.yaml
governance/evidence/audit-evidence-index.md governance/evidence/audit-evidence-index.md
governance/evidence/drill-evidence-template.md governance/evidence/drill-evidence-template.md
catalog/components/{service}.yaml catalog/components/{service}.yaml
@@ -3175,7 +3195,11 @@ governance/ownership/raci.yaml
governance/slo/tiering-policy.md governance/slo/tiering-policy.md
governance/architecture-gates/production-readiness.yaml governance/architecture-gates/production-readiness.yaml
governance/migration/deprecation-policy.md governance/migration/deprecation-policy.md
governance/evidence/release-evidence-checklist.md governance/evidence/releases/README.md
governance/evidence/supply-chain/README.md
governance/evidence/exceptions/README.md
governance/evidence/compatibility/README.md
governance/evidence/drift/README.md
contracts/apis/README.md contracts/apis/README.md
contracts/events/README.md contracts/events/README.md
contracts/datasets/README.md contracts/datasets/README.md
+1 -1
View File
@@ -144,7 +144,7 @@ documents:
role: 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档 role: 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档
- path: docs/references/modern-enterprise-architecture-kit/README.md - path: docs/references/modern-enterprise-architecture-kit/README.md
title: 现代企业数字化平台 Starter Kit title: 现代企业数字化平台 Starter Kit
role: 现代企业数字化平台 V2.219 组 schema、YAML 示例、嵌套约束和跨文件一致性校验入口 role: 现代企业数字化平台 V2.325 组 schema、YAML 示例、证据链字段和跨文件一致性校验入口
- path: docs/references/dataset-first-data-service.md - path: docs/references/dataset-first-data-service.md
title: Dataset First 数据服务结构 title: Dataset First 数据服务结构
role: dataset、contract、registry、runtime 为核心的数据服务模板 role: dataset、contract、registry、runtime 为核心的数据服务模板
+1 -1
View File
@@ -10,6 +10,6 @@
- `check-directory-docs.py`:仓库自有目录 `README.md` / `AGENTS.md` 覆盖检查脚本;根 `.github/` 仅要求 `AGENTS.md`,避免 GitHub 首页误展示平台配置说明。 - `check-directory-docs.py`:仓库自有目录 `README.md` / `AGENTS.md` 覆盖检查脚本;根 `.github/` 仅要求 `AGENTS.md`,避免 GitHub 首页误展示平台配置说明。
- `check-metadata.py``metadata/taxonomy.yml``metadata/redirects.yml` 路径和锚点检查脚本。 - `check-metadata.py``metadata/taxonomy.yml``metadata/redirects.yml` 路径和锚点检查脚本。
- `check-ai-citation.py``llms.txt``assets/ai-citation/llms-full.txt` 与 AI 引用语料路径和锚点检查脚本。 - `check-ai-citation.py``llms.txt``assets/ai-citation/llms-full.txt` 与 AI 引用语料路径和锚点检查脚本。
- `check-modern-architecture-kit.py`:现代企业数字化平台 starter kit 的 19 组 schema、示例和跨文件一致性检查脚本。 - `check-modern-architecture-kit.py`:现代企业数字化平台 starter kit 的 25 组 schema、示例和跨文件一致性检查脚本。
- `check-wiki.py`GitHub Wiki 独立仓库本地 checkout 的页面覆盖、内链和旧口径检查脚本。 - `check-wiki.py`GitHub Wiki 独立仓库本地 checkout 的页面覆盖、内链和旧口径检查脚本。
- `sync-doc-toc.py`:兼容旧线性 README 的细粒度目录生成脚本;当前拆分结构下通常无变更。 - `sync-doc-toc.py`:兼容旧线性 README 的细粒度目录生成脚本;当前拆分结构下通常无变更。