mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-27 18:57:50 +00:00
docs: references - add audit export automation
This commit is contained in:
@@ -70,7 +70,8 @@ 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` | 校验现代企业数字化平台版本清单、控制项覆盖清单、43 组 starter kit schema、示例、严格 schema、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度和跨文件一致性 | Python 3 |
|
||||
| `make check-modern-architecture-kit` | 校验现代企业数字化平台版本清单、控制项覆盖清单、43 组 starter kit schema、示例、严格 schema、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度和跨文件一致性 | Python 3 |
|
||||
| `make export-modern-architecture-audit` | 导出现代企业数字化平台审计证据包 | Python 3;先通过 `check-modern-architecture-kit` |
|
||||
| `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,16 +234,17 @@ 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` - 现代企业数字化平台版本清单、控制项覆盖清单、43 组 starter kit schema、示例、严格 schema、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度和跨文件一致性检查脚本,供 `make check-modern-architecture-kit` 与 CI 使用
|
||||
- `scripts/check-modern-architecture-kit.py` - 现代企业数字化平台版本清单、控制项覆盖清单、43 组 starter kit schema、示例、严格 schema、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度和跨文件一致性检查脚本,供 `make check-modern-architecture-kit` 与 CI 使用
|
||||
- `scripts/export-modern-architecture-audit.py` - 现代企业数字化平台审计包导出脚本,供 `make export-modern-architecture-audit` 使用
|
||||
- `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.11 机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
- `docs/references/modern-enterprise-architecture-controls.json` - 现代企业数字化平台 V2.11 控制项到 schema、example 和 checker 的证据链清单
|
||||
- `docs/references/modern-enterprise-architecture-kit/README.md` - 现代企业数字化平台 V2.11 starter kit、schema、示例和一致性校验入口
|
||||
- `docs/references/modern-enterprise-architecture-version.json` - 现代企业数字化平台 V2.12 机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
- `docs/references/modern-enterprise-architecture-controls.json` - 现代企业数字化平台 V2.12 控制项到 schema、example 和 checker 的证据链清单
|
||||
- `docs/references/modern-enterprise-architecture-kit/README.md` - 现代企业数字化平台 V2.12 starter kit、schema、示例和一致性校验入口
|
||||
- `docs/references/technology-stack.md` - 常见软件系统技术栈、选型维度、组合案例与初学者学习路径
|
||||
- `skills/auto-skill/` - Skills 生成、重构与校验的元技能
|
||||
- `skills/auto-tmux/` - tmux 自动化操控、脚本化 pane 巡检、按键注入、日志录制与多终端协作技能
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Makefile for Vibe Coding Guide
|
||||
|
||||
.PHONY: help lint check-links check-details check-doc-structure check-directory-docs check-metadata check-ai-citation check-modern-architecture-kit check-wiki sync-doc-toc build test clean clean-deps
|
||||
.PHONY: help lint check-links check-details check-doc-structure check-directory-docs check-metadata check-ai-citation check-modern-architecture-kit export-modern-architecture-audit check-wiki sync-doc-toc build test clean clean-deps
|
||||
|
||||
MARKDOWNLINT = npx --yes markdownlint-cli@0.48.0
|
||||
|
||||
@@ -17,6 +17,7 @@ help:
|
||||
@echo " check-metadata - Check metadata paths and anchors"
|
||||
@echo " check-ai-citation - Check llms and AI citation paths and anchors"
|
||||
@echo " check-modern-architecture-kit - Check modern enterprise architecture starter kit"
|
||||
@echo " export-modern-architecture-audit - Export modern architecture audit evidence packet"
|
||||
@echo " check-wiki - Check local GitHub Wiki checkout when present"
|
||||
@echo " sync-doc-toc - Regenerate docs fine-grained TOC blocks"
|
||||
@echo " build - Verify knowledge base has no build step"
|
||||
@@ -57,6 +58,10 @@ check-modern-architecture-kit:
|
||||
@echo "Checking modern enterprise architecture starter kit..."
|
||||
@python3 scripts/check-modern-architecture-kit.py
|
||||
|
||||
export-modern-architecture-audit:
|
||||
@echo "Exporting modern enterprise architecture audit packet..."
|
||||
@python3 scripts/export-modern-architecture-audit.py
|
||||
|
||||
check-wiki:
|
||||
@echo "Checking local GitHub Wiki checkout..."
|
||||
@python3 scripts/check-wiki.py --wiki-dir "$${WIKI_DIR:-/tmp/vibe-coding-cn.wiki}"
|
||||
|
||||
@@ -68,9 +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.11 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- docs/references/modern-enterprise-architecture-controls.json:现代企业数字化平台 V2.11 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- docs/references/modern-enterprise-architecture-kit/README.md:现代企业数字化平台 V2.11 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- docs/references/modern-enterprise-architecture-version.json:现代企业数字化平台 V2.12 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- docs/references/modern-enterprise-architecture-controls.json:现代企业数字化平台 V2.12 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- docs/references/modern-enterprise-architecture-kit/README.md:现代企业数字化平台 V2.12 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- docs/references/dataset-first-data-service.md:以 dataset、contract、registry、runtime 为核心的数据服务模板。
|
||||
- docs/references/code-organization.md:模块化、命名、注释、格式化、文档和工具。
|
||||
- docs/references/development-experience.md:变量名、文件结构、编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
+3
-3
@@ -63,9 +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.11 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- [现代企业数字化平台控制项覆盖清单](./references/modern-enterprise-architecture-controls.json) - 现代企业数字化平台 V2.11 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- [现代企业数字化平台 Starter Kit](./references/modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.11 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [现代企业数字化平台版本清单](./references/modern-enterprise-architecture-version.json) - 现代企业数字化平台 V2.12 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- [现代企业数字化平台控制项覆盖清单](./references/modern-enterprise-architecture-controls.json) - 现代企业数字化平台 V2.12 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- [现代企业数字化平台 Starter Kit](./references/modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.12 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [Dataset First 数据服务](./references/dataset-first-data-service.md) - 数据服务模板。
|
||||
- [代码组织](./references/code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
|
||||
- [开发经验](./references/development-experience.md) - 编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
@@ -20,9 +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.11 机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
├── modern-enterprise-architecture-controls.json # 现代企业数字化平台 V2.11 控制项到 schema、example 和 checker 的证据链清单
|
||||
├── modern-enterprise-architecture-kit/ # 现代企业数字化平台 V2.11 starter kit、schema、示例和一致性校验
|
||||
├── modern-enterprise-architecture-version.json # 现代企业数字化平台 V2.12 机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
├── modern-enterprise-architecture-controls.json # 现代企业数字化平台 V2.12 控制项到 schema、example 和 checker 的证据链清单
|
||||
├── modern-enterprise-architecture-kit/ # 现代企业数字化平台 V2.12 starter kit、schema、示例和一致性校验
|
||||
├── dataset-first-data-service.md
|
||||
├── code-organization.md
|
||||
├── development-experience.md
|
||||
|
||||
@@ -15,9 +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.11 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。 |
|
||||
| <a id="reference-modern-enterprise-architecture-controls"></a>[现代企业数字化平台控制项覆盖清单](modern-enterprise-architecture-controls.json) | 现代企业数字化平台 V2.11 的控制项到 schema、example 和 checker 的证据链清单。 |
|
||||
| <a id="reference-modern-enterprise-architecture-kit"></a>[现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) | 现代企业数字化平台 V2.11 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。 |
|
||||
| <a id="reference-modern-enterprise-architecture-version"></a>[现代企业数字化平台版本清单](modern-enterprise-architecture-version.json) | 现代企业数字化平台 V2.12 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。 |
|
||||
| <a id="reference-modern-enterprise-architecture-controls"></a>[现代企业数字化平台控制项覆盖清单](modern-enterprise-architecture-controls.json) | 现代企业数字化平台 V2.12 的控制项到 schema、example 和 checker 的证据链清单。 |
|
||||
| <a id="reference-modern-enterprise-architecture-kit"></a>[现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) | 现代企业数字化平台 V2.12 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、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) | 变量名、文件结构、编码规范、架构原则和常见基础设施经验。 |
|
||||
@@ -37,9 +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.11 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- [现代企业数字化平台控制项覆盖清单](modern-enterprise-architecture-controls.json) - 现代企业数字化平台 V2.11 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- [现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.11 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [现代企业数字化平台版本清单](modern-enterprise-architecture-version.json) - 现代企业数字化平台 V2.12 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口。
|
||||
- [现代企业数字化平台控制项覆盖清单](modern-enterprise-architecture-controls.json) - 现代企业数字化平台 V2.12 的控制项到 schema、example 和 checker 的证据链清单。
|
||||
- [现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.12 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口。
|
||||
- [Dataset First 数据服务结构](dataset-first-data-service.md) - 以 dataset、contract、registry、runtime 为核心的数据服务模板。
|
||||
- [代码组织](code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
|
||||
- [开发经验](development-experience.md) - 变量名、文件结构、编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# 现代企业数字化平台架构说明文档
|
||||
|
||||
**文档版本**:V2.11
|
||||
**文档版本**:V2.12
|
||||
**适用对象**:企业管理层、产品负责人、架构师、研发负责人、数据负责人、平台团队、安全合规团队
|
||||
**适用范围**:中大型企业数字化平台建设、业务系统重构、平台工程建设、数据产品化、组织协同机制设计
|
||||
**文档定位**:本文件用于说明现代企业数字化平台的总体架构、核心组成、团队职责、治理机制、技术原则和落地路径。
|
||||
**专项修订**:V2.11 在 V2.10 基础上新增控制证据映射和审计导出清单,并把控制项、证据路径、验证结果、签名要求和留存策略纳入 checker 证据链。
|
||||
**专项修订**:V2.12 在 V2.11 基础上新增审计导出自动化命令,让仓库可以先校验 starter kit,再生成 JSON 和 Markdown 审计证据包。
|
||||
|
||||
---
|
||||
|
||||
@@ -52,7 +52,7 @@
|
||||
|
||||
| 版本 | 状态 | 说明 |
|
||||
| ---- | ---- | ---- |
|
||||
| `V2.11` | `Baseline Candidate` | 用作可执行企业标准起点;包含机器可读版本清单、控制项覆盖清单、43 组 starter kit schema/example、控制证据映射、审计导出清单、严格 schema 模式、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、供应链证据链一致性和自动化校验入口 |
|
||||
| `V2.12` | `Baseline Candidate` | 用作可执行企业标准起点;包含机器可读版本清单、控制项覆盖清单、43 组 starter kit schema/example、控制证据映射、审计导出清单、审计导出自动化、严格 schema 模式、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、供应链证据链一致性和自动化校验入口 |
|
||||
|
||||
### 0.3 变更分级
|
||||
|
||||
@@ -121,12 +121,13 @@ git diff --check
|
||||
| `V2.9` | 2026-06-02 | Minor | 补齐隐私影响评估、租户隔离、恢复演练、策略测试、GenAI 观测和成本分摊证据 |
|
||||
| `V2.10` | 2026-06-02 | Minor | 补齐访问复核、密钥轮换、漏洞修复、事故复盘和证据新鲜度控制项 |
|
||||
| `V2.11` | 2026-06-02 | Minor | 补齐控制证据映射和审计导出清单 |
|
||||
| `V2.12` | 2026-06-02 | Minor | 补齐审计导出自动化命令 |
|
||||
|
||||
### 0.7 V2.11 可执行企业标准路线图
|
||||
### 0.7 V2.12 可执行企业标准路线图
|
||||
|
||||
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.7 启用严格 schema 模式,要求 starter kit 所有对象节点声明 `additionalProperties=false`,并由 checker 阻断未知字段。V2.8 补齐扩展字段策略、Feature Flag / Kill Switch、AI 威胁模型、运行血缘和平台产品指标。V2.9 继续把隐私工程、租户边界、恢复演练、Policy as Code 测试、GenAI 可观测性和 FinOps 成本分摊补成可执行证据。V2.10 把访问复核、密钥轮换、漏洞修复、事故复盘和证据新鲜度纳入控制目录,避免生产安全运营只停留在“有制度、有人看、事后补”的弱证据状态。V2.11 把每个控制项到证据路径、状态、新鲜度和审计导出包的关系纳入总账,避免审计时只能逐段翻文档、不能一键证明控制覆盖。后续 `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.7 启用严格 schema 模式,要求 starter kit 所有对象节点声明 `additionalProperties=false`,并由 checker 阻断未知字段。V2.8 补齐扩展字段策略、Feature Flag / Kill Switch、AI 威胁模型、运行血缘和平台产品指标。V2.9 继续把隐私工程、租户边界、恢复演练、Policy as Code 测试、GenAI 可观测性和 FinOps 成本分摊补成可执行证据。V2.10 把访问复核、密钥轮换、漏洞修复、事故复盘和证据新鲜度纳入控制目录,避免生产安全运营只停留在“有制度、有人看、事后补”的弱证据状态。V2.11 把每个控制项到证据路径、状态、新鲜度和审计导出包的关系纳入总账,避免审计时只能逐段翻文档、不能一键证明控制覆盖。V2.12 增加审计导出自动化命令,把版本、控制目录、证据映射、导出清单、脚本和关键制品哈希生成可交付审计包。后续 `V2.x` 迭代应继续补充示例仓库,并把平台、catalog、GitOps 和审计系统连接起来。
|
||||
|
||||
V2.11 起点包括:
|
||||
V2.12 起点包括:
|
||||
|
||||
1. 真相源字段矩阵:明确 `domain.yaml`、`service.yaml`、`ai-product.yaml`、`data-product.yaml`、catalog、GitOps 和 runtime 的字段权威。
|
||||
2. 契约模板:提供服务、领域、数据产品、AI 产品、Agent 工具、RAG、微调、GitOps 和生产就绪模板。
|
||||
@@ -158,6 +159,7 @@ V2.11 起点包括:
|
||||
28. 证据新鲜度:新增 `evidence-freshness-policy.yaml`,把证据最大年龄、按类型过期策略、CI 执行和过期阻断纳入审计生命周期。
|
||||
29. 控制证据映射:新增 `control-evidence-map.yaml`,把控制项 ID、证据路径、状态、新鲜度、必需性和阻断属性纳入审计总账。
|
||||
30. 审计导出清单:新增 `audit-export-manifest.yaml`,把导出包范围、内容、验证结果、签名要求和留存策略纳入可交付证据。
|
||||
31. 审计导出自动化:新增 `make export-modern-architecture-audit`,生成 `build/modern-enterprise-architecture-audit/audit-export.json` 和 `audit-export.md`。
|
||||
|
||||
---
|
||||
|
||||
@@ -2614,7 +2616,7 @@ runbook:
|
||||
rollback: docs/rollback.md
|
||||
```
|
||||
|
||||
V2.11 starter kit 还提供以下可执行契约模板:
|
||||
V2.12 starter kit 还提供以下可执行契约模板:
|
||||
|
||||
1. `api-contract.yaml`:API producer、consumer、auth、版本和兼容策略。
|
||||
2. `event-contract.yaml`:事件 topic、schema、幂等键、投递语义和消费者。
|
||||
@@ -2679,6 +2681,7 @@ V2.11 starter kit 还提供以下可执行契约模板:
|
||||
| 证据生命周期 | 证据最大年龄、按类型过期策略、CI 执行、过期阻断 | `evidence-freshness-policy.yaml`、审计索引、CI | 过期证据继续准入、关键证据不是必需项 |
|
||||
| 控制证据映射 | 控制项 ID、证据路径、状态、新鲜度、必需性、阻断属性 | `control-evidence-map.yaml`、控制目录、CI | 控制项无证据、证据过期、非阻断控制被误放行 |
|
||||
| 审计导出 | 架构版本、控制数量、starter kit 数量、导出内容、验证结果、签名、留存 | `audit-export-manifest.yaml`、审计包、签名系统 | 导出包范围不明、缺关键文件、未验证通过、未签名 |
|
||||
| 审计导出自动化 | 校验命令、导出脚本、JSON 包、Markdown 报告、制品哈希 | `make export-modern-architecture-audit`、导出脚本、build 输出 | 审计包只能手工拼接、未先校验、缺制品哈希 |
|
||||
| 运行 | SLO、成本、漂移、异常调用、供应链策略漂移 | runtime、observability、audit、漂移报告 | 错误预算耗尽、成本超预算、策略漂移 |
|
||||
|
||||
### 10.10.4 漂移检测规则
|
||||
@@ -2708,7 +2711,7 @@ V2.11 starter kit 还提供以下可执行契约模板:
|
||||
|
||||
可执行企业标准不能只证明“字段存在”,还要证明关键控制项确实被 schema、example 和 checker 覆盖。
|
||||
|
||||
V2.6 起,控制项覆盖清单由以下文件维护;V2.7 起,严格 schema 控制项进入同一清单;V2.8 起,扩展策略、发布开关、AI 威胁模型、运行血缘和平台产品指标也进入同一清单;V2.9 起,隐私影响评估、租户隔离、恢复演练、策略测试、GenAI 观测和成本分摊证据也进入同一清单;V2.10 起,访问复核、密钥轮换、漏洞修复、事故复盘和证据新鲜度也进入同一清单;V2.11 起,控制证据映射和审计导出清单也进入同一清单:
|
||||
V2.6 起,控制项覆盖清单由以下文件维护;V2.7 起,严格 schema 控制项进入同一清单;V2.8 起,扩展策略、发布开关、AI 威胁模型、运行血缘和平台产品指标也进入同一清单;V2.9 起,隐私影响评估、租户隔离、恢复演练、策略测试、GenAI 观测和成本分摊证据也进入同一清单;V2.10 起,访问复核、密钥轮换、漏洞修复、事故复盘和证据新鲜度也进入同一清单;V2.11 起,控制证据映射和审计导出清单也进入同一清单;V2.12 起,审计导出自动化命令也进入同一清单:
|
||||
|
||||
```text
|
||||
docs/references/modern-enterprise-architecture-controls.json
|
||||
@@ -2751,6 +2754,7 @@ docs/references/modern-enterprise-architecture-controls.json
|
||||
| 文档说证据不能过期继续准入,机器是否能证明 | 控制项要求 `evidence-freshness-policy.schema.json` 和示例包含最大年龄、过期阻断和 CI 执行 |
|
||||
| 文档说每个控制项都必须有可追踪证据,机器是否能证明 | 控制项要求 `control-evidence-map.schema.json` 和示例覆盖全部控制项 ID、证据路径、状态和新鲜度 |
|
||||
| 文档说审计包必须可导出和复核,机器是否能证明 | 控制项要求 `audit-export-manifest.schema.json` 和示例包含范围、内容、验证、签名和留存 |
|
||||
| 文档说审计包必须能由仓库生成,机器是否能证明 | 控制项要求 `scripts/export-modern-architecture-audit.py`、`Makefile` 入口和 checker 自动化检查 |
|
||||
|
||||
`make check-modern-architecture-kit` 必须校验控制清单自身,并校验清单中声明的 schema 字段、example 字段和 checker 证据确实存在。
|
||||
|
||||
@@ -2858,7 +2862,20 @@ docs/references/modern-enterprise-architecture-kit/
|
||||
make check-modern-architecture-kit
|
||||
```
|
||||
|
||||
该命令是仓库内零依赖 starter gate,用于校验版本清单、控制项覆盖清单、43 组示例的 JSON Schema 子集、YAML 示例、嵌套必填字段、格式约束、数值阈值、严格 schema 模式、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、控制证据映射、审计导出清单、未知字段阻断、证据链字段和示例间一致性。企业生产落地时应优先接入成熟校验器,例如 JSON Schema draft 2020-12 validator、YAML parser、OpenAPI / AsyncAPI checker、OPA / Cedar / Kyverno policy test、SLSA / Sigstore verifier、OpenTelemetry collector、OpenCost / FOCUS 工具链、IAM / Secret 管理系统、漏洞管理平台、事故管理系统、OSCAL 工具链和 GitOps diff 工具;本仓库脚本只作为 starter kit 的最小可执行证明。
|
||||
该命令是仓库内零依赖 starter gate,用于校验版本清单、控制项覆盖清单、43 组示例的 JSON Schema 子集、YAML 示例、嵌套必填字段、格式约束、数值阈值、严格 schema 模式、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、控制证据映射、审计导出清单、审计导出自动化命令、未知字段阻断、证据链字段和示例间一致性。企业生产落地时应优先接入成熟校验器,例如 JSON Schema draft 2020-12 validator、YAML parser、OpenAPI / AsyncAPI checker、OPA / Cedar / Kyverno policy test、SLSA / Sigstore verifier、OpenTelemetry collector、OpenCost / FOCUS 工具链、IAM / Secret 管理系统、漏洞管理平台、事故管理系统、OSCAL 工具链和 GitOps diff 工具;本仓库脚本只作为 starter kit 的最小可执行证明。
|
||||
|
||||
审计导出包由以下命令生成:
|
||||
|
||||
```bash
|
||||
make export-modern-architecture-audit
|
||||
```
|
||||
|
||||
默认输出:
|
||||
|
||||
```text
|
||||
build/modern-enterprise-architecture-audit/audit-export.json
|
||||
build/modern-enterprise-architecture-audit/audit-export.md
|
||||
```
|
||||
|
||||
```text
|
||||
governance/evidence/releases/{service-release}.yaml
|
||||
@@ -2907,6 +2924,7 @@ make check-doc-structure
|
||||
make check-metadata
|
||||
make check-ai-citation
|
||||
make check-modern-architecture-kit
|
||||
make export-modern-architecture-audit
|
||||
```
|
||||
|
||||
企业落地时还应补充:
|
||||
@@ -2930,6 +2948,7 @@ make check-modern-architecture-kit
|
||||
17. 审计证据最大年龄、过期动作和 CI 阻断检查。
|
||||
18. 控制项到证据路径、状态、新鲜度和阻断属性的映射检查。
|
||||
19. 审计导出包范围、内容、验证结果、签名和留存复审检查。
|
||||
20. 审计导出 JSON / Markdown 包生成、关键制品哈希和导出命令检查。
|
||||
|
||||
### 10.13.2 审计证据索引
|
||||
|
||||
@@ -2950,6 +2969,7 @@ make check-modern-architecture-kit
|
||||
| 事故证据 | 事故时间线、根因、行动项、runbook 和门禁更新 | SRE 和服务 owner | 事故关闭后继续保留一个审计周期 |
|
||||
| 控制映射证据 | 控制目录、证据路径、状态、新鲜度和阻断属性 | 治理团队和平台团队 | 覆盖每个基线版本 |
|
||||
| 审计导出证据 | 导出范围、内容清单、验证结果、签名和留存复审 | 治理团队和安全团队 | 覆盖每次正式审计导出 |
|
||||
| 审计导出自动化证据 | 导出命令、JSON 包、Markdown 报告、制品哈希和校验结果 | 治理团队和平台团队 | 覆盖每次正式审计导出 |
|
||||
| 例外证据 | 例外申请、风险接受、到期复审、关闭记录 | 治理团队 | 例外关闭后继续保留一个审计周期 |
|
||||
|
||||
`governance/evidence/audit-evidence-index.md` 应至少记录:
|
||||
|
||||
@@ -144,13 +144,13 @@ documents:
|
||||
role: 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档
|
||||
- path: docs/references/modern-enterprise-architecture-version.json
|
||||
title: 现代企业数字化平台版本清单
|
||||
role: 现代企业数字化平台 V2.11 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
role: 现代企业数字化平台 V2.12 的机器可读版本、发布状态、pair 清单、控制项数量和同步校验入口
|
||||
- path: docs/references/modern-enterprise-architecture-controls.json
|
||||
title: 现代企业数字化平台控制项覆盖清单
|
||||
role: 现代企业数字化平台 V2.11 的控制项到 schema、example 和 checker 的证据链清单
|
||||
role: 现代企业数字化平台 V2.12 的控制项到 schema、example 和 checker 的证据链清单
|
||||
- path: docs/references/modern-enterprise-architecture-kit/README.md
|
||||
title: 现代企业数字化平台 Starter Kit
|
||||
role: 现代企业数字化平台 V2.11 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口
|
||||
role: 现代企业数字化平台 V2.12 的 43 组 schema、YAML 示例、严格 schema 模式、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度、可靠性、数据治理、AI 运行、GitOps 安全、证据链字段和跨文件一致性校验入口
|
||||
- path: docs/references/dataset-first-data-service.md
|
||||
title: Dataset First 数据服务结构
|
||||
role: dataset、contract、registry、runtime 为核心的数据服务模板
|
||||
|
||||
+1
-1
@@ -10,7 +10,7 @@
|
||||
- 修改 docs README 或主题正文的主章节、锚点、索引后,优先运行 `python3 scripts/sync-doc-toc.py`,再运行 `make test`。
|
||||
- 修改 GitHub Wiki 独立仓库后,运行 `make check-wiki WIKI_DIR=/path/to/wiki`;不要把 Wiki checkout 提交进主仓。
|
||||
- 检查失败输出应包含文件路径、行号或可定位的错误信息。
|
||||
- 跳过目录必须明确,至少跳过 `.git`、`.history`、`node_modules` 和外部源码快照。
|
||||
- 跳过目录必须明确,至少跳过 `.git`、`.history`、`build`、`node_modules` 和外部源码快照。
|
||||
|
||||
## 验证
|
||||
|
||||
|
||||
+2
-1
@@ -10,6 +10,7 @@
|
||||
- `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`:现代企业数字化平台版本清单、控制项覆盖清单、43 组 starter kit schema、示例、严格 schema、控制证据映射、审计导出清单、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度和跨文件一致性检查脚本。
|
||||
- `check-modern-architecture-kit.py`:现代企业数字化平台版本清单、控制项覆盖清单、43 组 starter kit schema、示例、严格 schema、控制证据映射、审计导出清单、审计导出自动化、访问复核、密钥轮换、漏洞修复、事故复盘、证据新鲜度和跨文件一致性检查脚本。
|
||||
- `export-modern-architecture-audit.py`:现代企业数字化平台审计包导出脚本,先复用 starter kit checker 校验,再生成 JSON 和 Markdown 证据包。
|
||||
- `check-wiki.py`:GitHub Wiki 独立仓库本地 checkout 的页面覆盖、内链和旧口径检查脚本。
|
||||
- `sync-doc-toc.py`:兼容旧线性 README 的细粒度目录生成脚本;当前拆分结构下通常无变更。
|
||||
|
||||
@@ -48,9 +48,10 @@ README_OPTIONAL_DIRS = {
|
||||
Path(".github"),
|
||||
}
|
||||
GENERATED_OR_VENDOR_DIRS = [
|
||||
Path("build"),
|
||||
Path("node_modules"),
|
||||
]
|
||||
SKIP_PARTS = {".git", ".history", "node_modules", "__pycache__"}
|
||||
SKIP_PARTS = {".git", ".history", "build", "node_modules", "__pycache__"}
|
||||
SKIP_PREFIXES = [
|
||||
Path(".github/wiki"),
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user