docs: references - add executable architecture standard

This commit is contained in:
tukuaiai
2026-06-01 22:47:11 +08:00
parent 8dbe5a958d
commit b89aeac99e
10 changed files with 1928 additions and 138 deletions
+7 -3
View File
@@ -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