mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-02 05:37:45 +00:00
docs: references - add executable architecture standard
This commit is contained in:
@@ -9,7 +9,7 @@
|
||||
### 允许的操作
|
||||
- 读取、修改顶层文档:`README.md`、`AGENTS.md`、`CONTRIBUTING.md` 等
|
||||
- 读取、修改 `docs/`、`prompts/`、`skills/`、`tools/config/`、`tools/external/` 下的文档与代码
|
||||
- 执行 `make lint`、`make check-links`、`make check-details`、`make check-doc-structure`、`make check-directory-docs`、`make check-metadata`、`make check-ai-citation`、`make check-wiki`、`make sync-doc-toc`、prompts-library 转换工具
|
||||
- 执行 `make lint`、`make check-links`、`make check-details`、`make check-doc-structure`、`make check-directory-docs`、`make check-metadata`、`make check-ai-citation`、`make check-modern-architecture-kit`、`make check-wiki`、`make sync-doc-toc`、prompts-library 转换工具
|
||||
- 新增/修改提示词、技能、文档
|
||||
- 提交符合规范的 commit
|
||||
|
||||
@@ -70,6 +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` | 校验现代企业数字化平台 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 |
|
||||
@@ -231,12 +232,14 @@ 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` - 现代企业数字化平台 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-kit/README.md` - 现代企业数字化平台 V2.0 starter kit、schema 和示例入口
|
||||
- `docs/references/technology-stack.md` - 常见软件系统技术栈、选型维度、组合案例与初学者学习路径
|
||||
- `skills/auto-skill/` - Skills 生成、重构与校验的元技能
|
||||
- `skills/auto-tmux/` - tmux 自动化操控、脚本化 pane 巡检、按键注入、日志录制与多终端协作技能
|
||||
@@ -294,7 +297,8 @@ feat|fix|docs|chore|refactor|test: scope - summary
|
||||
5. `check required directory README and AGENTS files` - 仓库自有目录 README/AGENTS 覆盖检查
|
||||
6. `check metadata paths and anchors` - metadata 路径与锚点检查
|
||||
7. `check llms and AI citation paths and anchors` - llms 与 AI 引用语料路径和锚点检查
|
||||
8. `link-checker` - 链接有效性检查
|
||||
8. `check modern enterprise architecture kit` - 现代企业架构 starter kit schema 与示例一致性检查
|
||||
9. `link-checker` - 链接有效性检查
|
||||
|
||||
### 提交前清单
|
||||
- [ ] 运行 `make lint` 通过
|
||||
@@ -351,7 +355,7 @@ make test
|
||||
2. **Conversion Tool**: 使用 Python + pandas + openpyxl
|
||||
3. **Documentation Standard**: 用户文档使用中文;代码/文件名使用英文
|
||||
4. **Skills**: 每个技能有独立的 `SKILL.md`
|
||||
5. **Quality Gates**: `make test` 执行 Markdown lint、本地相对链接/锚点检查、折叠块结构检查、docs 结构检查、metadata 路径检查与 AI 引用路径检查
|
||||
5. **Quality Gates**: `make test` 执行 Markdown lint、本地相对链接/锚点检查、折叠块结构检查、docs 结构检查、metadata 路径检查、AI 引用路径检查与现代企业架构 starter kit 检查
|
||||
|
||||
## Development Workflow
|
||||
|
||||
|
||||
@@ -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-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 check-wiki sync-doc-toc build test clean clean-deps
|
||||
|
||||
MARKDOWNLINT = npx --yes markdownlint-cli@0.48.0
|
||||
|
||||
@@ -16,6 +16,7 @@ help:
|
||||
@echo " check-directory-docs - Check required README/AGENTS pairs"
|
||||
@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 " 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"
|
||||
@@ -52,6 +53,10 @@ check-ai-citation:
|
||||
@echo "Checking llms and AI citation paths and anchors..."
|
||||
@python3 scripts/check-ai-citation.py
|
||||
|
||||
check-modern-architecture-kit:
|
||||
@echo "Checking modern enterprise architecture starter kit..."
|
||||
@python3 scripts/check-modern-architecture-kit.py
|
||||
|
||||
check-wiki:
|
||||
@echo "Checking local GitHub Wiki checkout..."
|
||||
@python3 scripts/check-wiki.py --wiki-dir "$${WIKI_DIR:-/tmp/vibe-coding-cn.wiki}"
|
||||
@@ -64,7 +69,7 @@ sync-doc-toc:
|
||||
build:
|
||||
@echo "No build step: this repository is a documentation and knowledge-base project."
|
||||
|
||||
test: lint check-links check-details check-doc-structure check-directory-docs check-metadata check-ai-citation
|
||||
test: lint check-links check-details check-doc-structure check-directory-docs check-metadata check-ai-citation check-modern-architecture-kit
|
||||
@echo "Quality gates complete."
|
||||
|
||||
clean: clean-deps
|
||||
|
||||
@@ -67,7 +67,8 @@ GEOFlow 的关键启发是:GEO 不是关键词堆砌,而是内容工程链
|
||||
- docs/references/project-architecture-template.md:常见项目结构、架构设计原则、最低门禁和检查清单。
|
||||
- docs/references/python-project-skeleton.md:Python 应用、服务、脚本工具和库项目的通用骨架。
|
||||
- docs/references/enterprise-architecture-template.md:中大型工程组织、平台工程和多产品线参考模型。
|
||||
- docs/references/modern-enterprise-architecture-template.md:面向领域产品网络、内部平台、数据产品和联邦治理的完整说明文档。
|
||||
- docs/references/modern-enterprise-architecture-template.md:面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
|
||||
- docs/references/modern-enterprise-architecture-kit/README.md:现代企业数字化平台 V2.0 的 schema、YAML 示例和 starter kit 校验入口。
|
||||
- docs/references/dataset-first-data-service.md:以 dataset、contract、registry、runtime 为核心的数据服务模板。
|
||||
- docs/references/code-organization.md:模块化、命名、注释、格式化、文档和工具。
|
||||
- docs/references/development-experience.md:变量名、文件结构、编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
+2
-1
@@ -62,7 +62,8 @@
|
||||
- [项目架构模板](./references/project-architecture-template.md) - 常见项目结构、架构设计原则、最低门禁和检查清单。
|
||||
- [通用 Python 项目骨架](./references/python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。
|
||||
- [企业级架构模板](./references/enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。
|
||||
- [现代企业数字化平台架构](./references/modern-enterprise-architecture-template.md) - 面向领域产品网络、内部平台、数据产品和联邦治理的完整说明文档。
|
||||
- [现代企业数字化平台架构](./references/modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
|
||||
- [现代企业数字化平台 Starter Kit](./references/modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.0 的 schema、YAML 示例和 starter kit 校验入口。
|
||||
- [Dataset First 数据服务](./references/dataset-first-data-service.md) - 数据服务模板。
|
||||
- [代码组织](./references/code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
|
||||
- [开发经验](./references/development-experience.md) - 编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
@@ -19,7 +19,8 @@ references/
|
||||
├── project-architecture-template.md
|
||||
├── python-project-skeleton.md
|
||||
├── enterprise-architecture-template.md
|
||||
├── modern-enterprise-architecture-template.md
|
||||
├── modern-enterprise-architecture-template.md # 现代企业数字化平台、版本治理、可执行标准、RACI、可靠性分级、仓库拓扑、迁移弃用、审计证据、微服务容器 GitOps、AI 原生能力、供应链安全和联邦治理蓝图
|
||||
├── modern-enterprise-architecture-kit/ # 现代企业数字化平台 V2.0 starter kit、schema 和示例
|
||||
├── dataset-first-data-service.md
|
||||
├── code-organization.md
|
||||
├── development-experience.md
|
||||
|
||||
@@ -14,7 +14,8 @@
|
||||
| <a id="reference-engineering-practice-1-项目架构模板"></a>[项目架构模板](project-architecture-template.md) | 常见项目结构、架构设计原则、最低门禁和检查清单。 |
|
||||
| <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) | 面向领域产品网络、内部平台、数据产品和联邦治理的完整说明文档。 |
|
||||
| <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.0 的 schema、YAML 示例和 starter kit 校验入口。 |
|
||||
| <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) | 变量名、文件结构、编码规范、架构原则和常见基础设施经验。 |
|
||||
@@ -33,7 +34,8 @@
|
||||
- [项目架构模板](project-architecture-template.md) - 常见项目结构、架构设计原则、最低门禁和检查清单。
|
||||
- [通用 Python 项目骨架](python-project-skeleton.md) - Python 应用、服务、脚本工具和库项目的通用骨架。
|
||||
- [企业级 Monorepo / Multi-repo 架构模板](enterprise-architecture-template.md) - 中大型工程组织、平台工程和多产品线参考模型。
|
||||
- [现代企业数字化平台架构](modern-enterprise-architecture-template.md) - 面向领域产品网络、内部平台、数据产品和联邦治理的完整说明文档。
|
||||
- [现代企业数字化平台架构](modern-enterprise-architecture-template.md) - 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档。
|
||||
- [现代企业数字化平台 Starter Kit](modern-enterprise-architecture-kit/README.md) - 现代企业数字化平台 V2.0 的 schema、YAML 示例和 starter kit 校验入口。
|
||||
- [Dataset First 数据服务结构](dataset-first-data-service.md) - 以 dataset、contract、registry、runtime 为核心的数据服务模板。
|
||||
- [代码组织](code-organization.md) - 模块化、命名、注释、格式化、文档和工具。
|
||||
- [开发经验](development-experience.md) - 变量名、文件结构、编码规范、架构原则和常见基础设施经验。
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -43,6 +43,7 @@ vibe-coding-cn 是一个中文 Vibe Coding / AI 结对编程系统教程,帮
|
||||
- docs/references/python-project-skeleton.md
|
||||
- docs/references/enterprise-architecture-template.md
|
||||
- docs/references/modern-enterprise-architecture-template.md
|
||||
- docs/references/modern-enterprise-architecture-kit/README.md
|
||||
- docs/references/dataset-first-data-service.md
|
||||
- docs/references/code-organization.md
|
||||
- docs/references/development-experience.md
|
||||
|
||||
@@ -141,7 +141,10 @@ documents:
|
||||
role: 中大型工程组织、平台工程和多产品线参考模型
|
||||
- path: docs/references/modern-enterprise-architecture-template.md
|
||||
title: 现代企业数字化平台架构
|
||||
role: 面向领域产品网络、内部平台、数据产品和联邦治理的完整说明文档
|
||||
role: 面向领域产品网络、微服务容器 GitOps 边界、AI 原生能力、微调治理、AI 事件响应、内部平台、数据产品、供应链安全、FinOps 成本治理、版本治理、可执行标准、RACI 决策权、可靠性分级、仓库拓扑、迁移弃用、审计证据、联邦治理和行业对标矩阵的完整说明文档
|
||||
- path: docs/references/modern-enterprise-architecture-kit/README.md
|
||||
title: 现代企业数字化平台 Starter Kit
|
||||
role: 现代企业数字化平台 V2.0 的 schema、YAML 示例和 starter kit 校验入口
|
||||
- path: docs/references/dataset-first-data-service.md
|
||||
title: Dataset First 数据服务结构
|
||||
role: dataset、contract、registry、runtime 为核心的数据服务模板
|
||||
|
||||
@@ -10,5 +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`:现代企业数字化平台 starter kit 的 schema 与示例一致性检查脚本。
|
||||
- `check-wiki.py`:GitHub Wiki 独立仓库本地 checkout 的页面覆盖、内链和旧口径检查脚本。
|
||||
- `sync-doc-toc.py`:兼容旧线性 README 的细粒度目录生成脚本;当前拆分结构下通常无变更。
|
||||
|
||||
Reference in New Issue
Block a user