mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-27 18:57:50 +00:00
docs: references - add architecture control coverage
This commit is contained in:
tradecatlabs
@@ -70,7 +70,7 @@ git push origin develop
|
||||
| `make check-directory-docs` | 校验仓库自有目录 README/AGENTS 覆盖 | Python 3 |
|
||||
| `make check-metadata` | 校验 metadata 路径与锚点 | Python 3 |
|
||||
| `make check-ai-citation` | 校验 llms 与 AI 引用语料路径和锚点 | Python 3 |
|
||||
| `make check-modern-architecture-kit` | 校验现代企业数字化平台版本清单、25 组 starter kit schema、示例和跨文件一致性 | Python 3 |
|
||||
| `make check-modern-architecture-kit` | 校验现代企业数字化平台版本清单、控制项覆盖清单、25 组 starter kit 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 sync-doc-toc` | 兼容旧线性 README 目录生成；当前拆分结构下通常无变更 | Python 3 |
|
||||
| `make test` | 执行本地质量门禁 | Node.js 22+、Python 3 |
|
||||
@@ -233,15 +233,16 @@ git push origin develop
|
||||
- `scripts/check-directory-docs.py` - 仓库自有目录 README/AGENTS 覆盖检查脚本，供 `make check-directory-docs` 与 CI 使用
|
||||
- `scripts/check-metadata.py` - metadata 路径与锚点检查脚本，供 `make check-metadata` 与 CI 使用
|
||||
- `scripts/check-ai-citation.py` - llms 与 AI 引用语料路径和锚点检查脚本，供 `make check-ai-citation` 与 CI 使用
|
||||
- `scripts/check-modern-architecture-kit.py` - 现代企业数字化平台版本清单、25 组 starter kit schema、示例和跨文件一致性检查脚本，供 `make check-modern-architecture-kit` 与 CI 使用
|
||||
- `scripts/check-modern-architecture-kit.py` - 现代企业数字化平台版本清单、控制项覆盖清单、25 组 starter kit schema、示例和跨文件一致性检查脚本，供 `make check-modern-architecture-kit` 与 CI 使用
|
||||
- `scripts/check-wiki.py` - GitHub Wiki 独立仓库本地 checkout 页面覆盖、内链和旧口径检查脚本，供 `make check-wiki` 使用
|
||||
- `scripts/sync-doc-toc.py` - docs README 细粒度目录兼容脚本，当前拆分结构下通常无变更，供 `make sync-doc-toc` 使用
|
||||
- `tools/prompts-library/main.py` - 提示词转换工具入口
|
||||
- `docs/getting-started/README.md` - 从零开始索引入口，正文拆分到学习地图、Vibe Coding 经验、网络配置、CLI 配置与开发环境搭建
|
||||
- `docs/concepts/problem-solving.md` - 问题定义与求解路径底层模型
|
||||
- `docs/references/project-architecture-template.md` - 常见项目结构、架构设计原则、最低门禁和检查清单
|
||||
- `docs/references/modern-enterprise-architecture-version.json` - 现代企业数字化平台 V2.5 机器可读版本、发布状态、pair 清单和同步校验入口
|
||||
- `docs/references/modern-enterprise-architecture-kit/README.md` - 现代企业数字化平台 V2.5 starter kit、schema、示例和一致性校验入口
|
||||
- `docs/references/modern-enterprise-architecture-version.json` - 现代企业数字化平台 V2.6 机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
- `docs/references/modern-enterprise-architecture-controls.json` - 现代企业数字化平台 V2.6 控制项到 schema、example 和 checker 的证据链清单
|
||||
- `docs/references/modern-enterprise-architecture-kit/README.md` - 现代企业数字化平台 V2.6 starter kit、schema、示例和一致性校验入口
|
||||
- `docs/references/technology-stack.md` - 常见软件系统技术栈、选型维度、组合案例与初学者学习路径
|
||||
- `skills/auto-skill/` - Skills 生成、重构与校验的元技能
|
||||
- `skills/auto-tmux/` - tmux 自动化操控、脚本化 pane 巡检、按键注入、日志录制与多终端协作技能
|
||||
|
||||
@@ -68,8 +68,9 @@ GEOFlow 的关键启发是：GEO 不是关键词堆砌，而是内容工程链
|
||||
- docs/references/python-project-skeleton.md：Python 应用、服务、脚本工具和库项目的通用骨架。
|
||||
- docs/references/enterprise-architecture-template.md：中大型工程组织、平台工程和多产品线参考模型。
|
||||
- docs/references/modern-enterprise-architecture-template.md：面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
|
||||
- docs/references/modern-enterprise-architecture-version.json：现代企业数字化平台 V2.5 的机器可读版本、发布状态、pair 清单和同步校验入口。
|
||||
- docs/references/modern-enterprise-architecture-kit/README.md：现代企业数字化平台 V2.5 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- docs/references/modern-enterprise-architecture-version.json：现代企业数字化平台 V2.6 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- docs/references/modern-enterprise-architecture-controls.json：现代企业数字化平台 V2.6 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- docs/references/modern-enterprise-architecture-kit/README.md：现代企业数字化平台 V2.6 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- docs/references/dataset-first-data-service.md：以 dataset、contract、registry、runtime 为核心的数据服务模板。
|
||||
- docs/references/code-organization.md：模块化、命名、注释、格式化、文档和工具。
|
||||
- docs/references/development-experience.md：变量名、文件结构、编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
+3
-2
@@ -63,8 +63,9 @@
|
||||
- [通用 Python 项目骨架](./references/python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。
|
||||
- [企业级架构模板](./references/enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。
|
||||
- [现代企业数字化平台架构](./references/modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
|
||||
- [现代企业数字化平台版本清单](./references/modern-enterprise-architecture-version.json) - 现代企业数字化平台 V2.5 的机器可读版本、发布状态、pair 清单和同步校验入口。
|
||||
- [现代企业数字化平台 Starter Kit](./references/modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.5 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [现代企业数字化平台版本清单](./references/modern-enterprise-architecture-version.json) - 现代企业数字化平台 V2.6 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- [现代企业数字化平台控制项覆盖清单](./references/modern-enterprise-architecture-controls.json) - 现代企业数字化平台 V2.6 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- [现代企业数字化平台 Starter Kit](./references/modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.6 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [Dataset First 数据服务](./references/dataset-first-data-service.md) - 数据服务模板。
|
||||
- [代码组织](./references/code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
|
||||
- [开发经验](./references/development-experience.md) - 编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
@@ -20,8 +20,9 @@ references/
|
||||
├── python-project-skeleton.md
|
||||
├── enterprise-architecture-template.md
|
||||
├── modern-enterprise-architecture-template.md # 现代企业数字化平台、版本治理、可执行标准、RACI、可靠性分级、仓库拓扑、迁移弃用、审计证据、微服务容器 GitOps、AI 原生能力、供应链安全和联邦治理蓝图
|
||||
├── modern-enterprise-architecture-version.json # 现代企业数字化平台 V2.5 机器可读版本、发布状态、pair 清单和同步校验入口
|
||||
├── modern-enterprise-architecture-kit/ # 现代企业数字化平台 V2.5 starter kit、schema、示例和一致性校验
|
||||
├── modern-enterprise-architecture-version.json # 现代企业数字化平台 V2.6 机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
├── modern-enterprise-architecture-controls.json # 现代企业数字化平台 V2.6 控制项到 schema、example 和 checker 的证据链清单
|
||||
├── modern-enterprise-architecture-kit/ # 现代企业数字化平台 V2.6 starter kit、schema、示例和一致性校验
|
||||
├── dataset-first-data-service.md
|
||||
├── code-organization.md
|
||||
├── development-experience.md
|
||||
|
||||
@@ -15,8 +15,9 @@
|
||||
| <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-modern-enterprise-architecture-template"></a>[现代企业数字化平台架构](modern-enterprise-architecture-template.md) | 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。 |
|
||||
| <a id="reference-modern-enterprise-architecture-version"></a>[现代企业数字化平台版本清单](modern-enterprise-architecture-version.json) | 现代企业数字化平台 V2.5 的机器可读版本、发布状态、pair 清单和同步校验入口。 |
|
||||
| <a id="reference-modern-enterprise-architecture-kit"></a>[现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) | 现代企业数字化平台 V2.5 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。 |
|
||||
| <a id="reference-modern-enterprise-architecture-version"></a>[现代企业数字化平台版本清单](modern-enterprise-architecture-version.json) | 现代企业数字化平台 V2.6 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。 |
|
||||
| <a id="reference-modern-enterprise-architecture-controls"></a>[现代企业数字化平台控制项覆盖清单](modern-enterprise-architecture-controls.json) | 现代企业数字化平台 V2.6 的控制项到 schema、example 和 checker 的证据链清单。 |
|
||||
| <a id="reference-modern-enterprise-architecture-kit"></a>[现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) | 现代企业数字化平台 V2.6 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。 |
|
||||
| <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-3-开发经验"></a>[开发经验](development-experience.md) | 变量名、文件结构、编码规范、架构原则和常见基础设施经验。 |
|
||||
@@ -36,8 +37,9 @@
|
||||
- [通用 Python 项目骨架](python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。
|
||||
- [企业级 Monorepo / Multi-repo 架构模板](enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。
|
||||
- [现代企业数字化平台架构](modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
|
||||
- [现代企业数字化平台版本清单](modern-enterprise-architecture-version.json) - 现代企业数字化平台 V2.5 的机器可读版本、发布状态、pair 清单和同步校验入口。
|
||||
- [现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.5 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [现代企业数字化平台版本清单](modern-enterprise-architecture-version.json) - 现代企业数字化平台 V2.6 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- [现代企业数字化平台控制项覆盖清单](modern-enterprise-architecture-controls.json) - 现代企业数字化平台 V2.6 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- [现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.6 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [Dataset First 数据服务结构](dataset-first-data-service.md) - 以 dataset、contract、registry、runtime 为核心的数据服务模板。
|
||||
- [代码组织](code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
|
||||
- [开发经验](development-experience.md) - 变量名、文件结构、编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# 现代企业数字化平台架构说明文档
|
||||
|
||||
**文档版本**：V2.5
|
||||
**文档版本**：V2.6
|
||||
**适用对象**：企业管理层、产品负责人、架构师、研发负责人、数据负责人、平台团队、安全合规团队
|
||||
**适用范围**：中大型企业数字化平台建设、业务系统重构、平台工程建设、数据产品化、组织协同机制设计
|
||||
**文档定位**：本文件用于说明现代企业数字化平台的总体架构、核心组成、团队职责、治理机制、技术原则和落地路径。
|
||||
**专项修订**：V2.5 在 V2.4 基础上加固可靠性、数据治理、AI 运行、GitOps 安全和供应链门禁字段。
|
||||
**专项修订**：V2.6 在 V2.5 基础上新增机器可读控制项覆盖清单，校验控制项到 schema、example 和 checker 的证据链。
|
||||
|
||||
---
|
||||
|
||||
@@ -52,7 +52,7 @@
|
||||
|
||||
| 版本 | 状态 | 说明 |
|
||||
| ---- | ---- | ---- |
|
||||
| `V2.5` | `Baseline Candidate` | 用作可执行企业标准起点；包含机器可读版本清单、25 组 starter kit schema/example、可靠性、数据治理、AI 运行、GitOps 安全、供应链证据链一致性和自动化校验入口 |
|
||||
| `V2.6` | `Baseline Candidate` | 用作可执行企业标准起点；包含机器可读版本清单、控制项覆盖清单、25 组 starter kit schema/example、可靠性、数据治理、AI 运行、GitOps 安全、供应链证据链一致性和自动化校验入口 |
|
||||
|
||||
### 0.3 变更分级
|
||||
|
||||
@@ -70,11 +70,12 @@
|
||||
1. 变更摘要：说明新增、修改、删除和废弃内容。
|
||||
2. 影响范围：列出受影响的架构层、目录、团队、契约、门禁和落地流程。
|
||||
3. 决策记录：重大变更必须链接 ADR 或评审记录。
|
||||
4. 版本清单：同步更新 `docs/references/modern-enterprise-architecture-version.json`，并让 CI 校验版本、状态、pair 数量和索引提及。
|
||||
5. 索引同步：同步更新 `docs/README.md`、`docs/references/README.md`、`metadata/taxonomy.yml` 和 AI 引用语料入口。
|
||||
6. 链接校验：仓库内 Markdown 链接和锚点必须通过检查。
|
||||
7. 格式校验：Markdown lint 和文档结构检查必须通过。
|
||||
8. 回滚入口：保留上一版本引用、Git commit 或变更记录，保证可以回退到上一基线。
|
||||
4. 版本清单：同步更新 `docs/references/modern-enterprise-architecture-version.json`，并让 CI 校验版本、状态、pair 数量、控制项数量和索引提及。
|
||||
5. 控制覆盖：同步更新 `docs/references/modern-enterprise-architecture-controls.json`，并让 CI 校验控制项到 schema、example 和 checker 证据链。
|
||||
6. 索引同步：同步更新 `docs/README.md`、`docs/references/README.md`、`metadata/taxonomy.yml` 和 AI 引用语料入口。
|
||||
7. 链接校验：仓库内 Markdown 链接和锚点必须通过检查。
|
||||
8. 格式校验：Markdown lint 和文档结构检查必须通过。
|
||||
9. 回滚入口：保留上一版本引用、Git commit 或变更记录，保证可以回退到上一基线。
|
||||
|
||||
推荐发布检查：
|
||||
|
||||
@@ -114,12 +115,13 @@ git diff --check
|
||||
| `V2.3` | 2026-06-01 | Minor | 补齐发布证据、供应链证明、治理例外、API/Event 兼容性报告和 GitOps 漂移报告契约模板 |
|
||||
| `V2.4` | 2026-06-01 | Minor | 增加机器可读版本清单、starter kit pair 清单和版本同步校验规则 |
|
||||
| `V2.5` | 2026-06-02 | Minor | 加固可靠性、数据治理、AI 运行、GitOps 安全和供应链门禁字段 |
|
||||
| `V2.6` | 2026-06-02 | Minor | 新增机器可读控制项覆盖清单，校验控制项到 schema、example 和 checker 的证据链 |
|
||||
|
||||
### 0.7 V2.5 可执行企业标准路线图
|
||||
### 0.7 V2.6 可执行企业标准路线图
|
||||
|
||||
V2.0 已将 V1.9 的文档化基线转化为第一批可执行资产。V2.1 继续把字段约束、示例一致性和远程 CI 门禁补强为可执行口径。V2.2 把主文档最小验证包中的 API、事件、AI 工具、RAG、微调、GitOps、catalog 和 scorecard 纳入 schema/example 校验。V2.3 继续把发布证据、供应链证明、治理例外、兼容性报告和 GitOps 漂移报告纳入机器可校验基线。V2.4 把当前版本、发布状态、starter kit pair 清单、pair 数量和索引同步要求固化到机器可读版本清单中。V2.5 把可靠性等级、RTO/RPO、数据保留与访问审计、AI 预算与降级、GitOps 运行安全和供应链 source/vulnerability/scorecard 证据提升为 starter kit 强制字段。后续 `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.4 把当前版本、发布状态、starter kit pair 清单、pair 数量和索引同步要求固化到机器可读版本清单中。V2.5 把可靠性等级、RTO/RPO、数据保留与访问审计、AI 预算与降级、GitOps 运行安全和供应链 source/vulnerability/scorecard 证据提升为 starter kit 强制字段。V2.6 增加控制项覆盖清单，把关键企业控制要求映射到 schema 字段、示例字段和 checker 规则，避免“文档说有控制、机器无法证明控制存在”。后续 `V2.x` 迭代应继续补充示例仓库，并把平台、catalog、GitOps 和审计系统连接起来。
|
||||
|
||||
V2.5 起点包括：
|
||||
V2.6 起点包括：
|
||||
|
||||
1. 真相源字段矩阵：明确 `domain.yaml`、`service.yaml`、`ai-product.yaml`、`data-product.yaml`、catalog、GitOps 和 runtime 的字段权威。
|
||||
2. 契约模板：提供服务、领域、数据产品、AI 产品、Agent 工具、RAG、微调、GitOps 和生产就绪模板。
|
||||
@@ -131,6 +133,7 @@ V2.5 起点包括：
|
||||
8. 验证包：提供 `make test`、schema 校验、示例仓库和审计证据清单，证明标准可以落地执行。
|
||||
9. Starter Kit：提供 `docs/references/modern-enterprise-architecture-kit/` 下的 25 组 schema/example、嵌套字段校验、格式校验、可靠性、数据治理、AI 运行、GitOps 安全、证据链验真字段和示例跨文件一致性检查。
|
||||
10. 版本清单：提供 `docs/references/modern-enterprise-architecture-version.json`，让当前版本、发布状态、pair 清单和索引同步进入 CI 校验。
|
||||
11. 控制项覆盖清单：提供 `docs/references/modern-enterprise-architecture-controls.json`，让关键控制项到 schema、example 和 checker 的证据链进入 CI 校验。
|
||||
|
||||
---
|
||||
|
||||
@@ -2587,7 +2590,7 @@ runbook:
|
||||
rollback: docs/rollback.md
|
||||
```
|
||||
|
||||
V2.5 starter kit 还提供以下可执行契约模板：
|
||||
V2.6 starter kit 还提供以下可执行契约模板：
|
||||
|
||||
1. `api-contract.yaml`：API producer、consumer、auth、版本和兼容策略。
|
||||
2. `event-contract.yaml`：事件 topic、schema、幂等键、投递语义和消费者。
|
||||
@@ -2642,6 +2645,37 @@ V2.5 starter kit 还提供以下可执行契约模板：
|
||||
3. catalog 漂移优先通过重新生成或重新校验修复，不应手工覆盖源头契约。
|
||||
4. 涉及生产安全、AI 高风险工具、数据权限和供应链证明的漂移必须阻断发布。
|
||||
|
||||
### 10.10.5 控制项覆盖清单
|
||||
|
||||
可执行企业标准不能只证明“字段存在”，还要证明关键控制项确实被 schema、example 和 checker 覆盖。
|
||||
|
||||
V2.6 起，控制项覆盖清单由以下文件维护：
|
||||
|
||||
```text
|
||||
docs/references/modern-enterprise-architecture-controls.json
|
||||
```
|
||||
|
||||
该清单采用轻量控制目录结构，不替代完整 OSCAL 实施。它至少记录：
|
||||
|
||||
1. 控制项 ID、分类、标题和控制声明。
|
||||
2. 控制项对齐的参考来源，例如 NIST OSCAL、SLSA、NIST SSDF。
|
||||
3. 必须存在的文档、schema、example 或脚本。
|
||||
4. 必须出现在 schema `required` 和 `properties` 中的字段。
|
||||
5. 必须出现在 YAML example 中的字段。
|
||||
6. 必须出现在 checker 中的自动化证据规则。
|
||||
|
||||
控制项覆盖清单用于回答：
|
||||
|
||||
| 问题 | 证明方式 |
|
||||
| ---- | -------- |
|
||||
| 文档说生产服务必须有 RTO/RPO，机器是否能证明 | 控制项要求 `service.schema.json` 和 `service.example.yaml` 包含 `reliability.rto`、`reliability.rpo` |
|
||||
| 文档说数据产品必须有访问审计，机器是否能证明 | 控制项要求 `data-product.schema.json` 和示例包含 `accessPolicy`、`audit`、`retention` |
|
||||
| 文档说 AI 产品必须可降级和控成本，机器是否能证明 | 控制项要求 `ai-product.schema.json` 和示例包含 `budget`、`fallback`、`providerPolicy` |
|
||||
| 文档说 GitOps 必须有运行安全，机器是否能证明 | 控制项要求 `gitops-deployment.schema.json` 和示例包含 `serviceAccount`、`security`、`scaling` |
|
||||
| 文档说供应链必须有漏洞和 Scorecard 证据，机器是否能证明 | 控制项要求 `supply-chain-attestation.schema.json` 和示例包含 `vulnerability`、`scorecard` |
|
||||
|
||||
`make check-modern-architecture-kit` 必须校验控制清单自身，并校验清单中声明的 schema 字段、example 字段和 checker 证据确实存在。
|
||||
|
||||
## 10.11 仓库拓扑剖面
|
||||
|
||||
目录结构可以按企业规模、团队自治程度和合规要求裁剪，但真相源边界不能裁剪。仓库拓扑的选择应先看 ownership、变更频率、权限隔离、发布节奏和审计要求，而不是看团队偏好的 Git 管理方式。
|
||||
@@ -2746,7 +2780,7 @@ docs/references/modern-enterprise-architecture-kit/
|
||||
make check-modern-architecture-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 的最小可执行证明。
|
||||
该命令是仓库内零依赖 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
|
||||
governance/evidence/releases/{service-release}.yaml
|
||||
|
||||
@@ -144,10 +144,13 @@ documents:
|
||||
role: 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档
|
||||
- path: docs/references/modern-enterprise-architecture-version.json
|
||||
title: 现代企业数字化平台版本清单
|
||||
role: 现代企业数字化平台 V2.5 的机器可读版本、发布状态、pair 清单和同步校验入口
|
||||
role: 现代企业数字化平台 V2.6 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
- path: docs/references/modern-enterprise-architecture-controls.json
|
||||
title: 现代企业数字化平台控制项覆盖清单
|
||||
role: 现代企业数字化平台 V2.6 的控制项到 schema、example 和 checker 的证据链清单
|
||||
- path: docs/references/modern-enterprise-architecture-kit/README.md
|
||||
title: 现代企业数字化平台 Starter Kit
|
||||
role: 现代企业数字化平台 V2.5 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口
|
||||
role: 现代企业数字化平台 V2.6 的 25 组 schema、YAML 示例、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口
|
||||
- path: docs/references/dataset-first-data-service.md
|
||||
title: Dataset First 数据服务结构
|
||||
role: dataset、contract、registry、runtime 为核心的数据服务模板
|
||||
|
||||
+1
-1
@@ -10,6 +10,6 @@
|
||||
- `check-directory-docs.py`：仓库自有目录 `README.md` / `AGENTS.md` 覆盖检查脚本；根 `.github/` 仅要求 `AGENTS.md`，避免 GitHub 首页误展示平台配置说明。
|
||||
- `check-metadata.py`：`metadata/taxonomy.yml` 与 `metadata/redirects.yml` 路径和锚点检查脚本。
|
||||
- `check-ai-citation.py`：`llms.txt`、`assets/ai-citation/llms-full.txt` 与 AI 引用语料路径和锚点检查脚本。
|
||||
- `check-modern-architecture-kit.py`：现代企业数字化平台版本清单、25 组 starter kit schema、示例和跨文件一致性检查脚本。
|
||||
- `check-modern-architecture-kit.py`：现代企业数字化平台版本清单、控制项覆盖清单、25 组 starter kit schema、示例和跨文件一致性检查脚本。
|
||||
- `check-wiki.py`：GitHub Wiki 独立仓库本地 checkout 的页面覆盖、内链和旧口径检查脚本。
|
||||
- `sync-doc-toc.py`：兼容旧线性 README 的细粒度目录生成脚本；当前拆分结构下通常无变更。
|
||||
|
||||
Reference in New Issue
Block a user