docs: add keyword system

- Add docs/concepts/keyword-system.md and wire it into README, docs indexes, taxonomy, llms.txt, and AI citation context.\n- Exclude unstable zread.ai links from lychee external link checks.
This commit is contained in:
土块
2026-06-30 01:42:48 +08:00
committed by GitHub
parent fafdc42e6e
commit 6832a1abe5
9 changed files with 279 additions and 89 deletions
+1
View File
@@ -34,6 +34,7 @@ exclude = [
'^https://platform\.openai\.com.*',
'^https://user-images\.githubusercontent\.com.*',
'^https://notebooklm\.google\.com.*',
'^https://zread\.ai/.*',
'^https://www\.contributor-covenant\.org.*',
'^https://javabetter\.cn/.*',
]
+83 -83
View File
@@ -116,7 +116,7 @@
| [docs](docs/README.md) | 知识库总入口,先从这里选择学习路线 |
| [getting-started](docs/getting-started/README.md) | 新手启动入口,配置网络、Codex CLI、开发环境和 Git 闭环 |
| [workflow](docs/workflow/README.md) | 项目执行入口,把需求推进成计划、修改、门禁、提交和复盘 |
| [concepts](docs/concepts/README.md) | 概念入口,理解问题求解、拼好码系统构建 |
| [concepts](docs/concepts/README.md) | 概念入口,理解问题求解、拼好码系统构建和关键词系统 |
| [references](docs/references/README.md) | 工程实践入口,查技术栈、质量门禁、模板和常见坑 |
| [philosophy](docs/philosophy/README.md) | 思维入口,补思维模型、编程之道和软件工程常识 |
| [research](docs/research/README.md) | 研究入口,记录新技术、优秀 repo 和工程趋势判断 |
@@ -256,66 +256,6 @@
</details>
<details>
<summary><strong>🛠️ 仓库维护与验证</strong>(点击展开/收起)</summary>
## 🛠️ 仓库维护与验证
本仓库是文档与资源型项目,不提供可验证的 dev server、Docker/K8s 部署入口或固定服务端口。当前可验证的自动化入口来自 `Makefile``.github/workflows/ci.yml``scripts/check-local-links.py``tools/prompts-library/`
### 环境要求
- Git:版本控制与 submodule 初始化
- Node.js 22+:通过 `npx --yes markdownlint-cli@0.48.0` 运行固定版本 Markdown lint
- Python 3.8+:运行 prompts-library 与链接检查脚本
### 初始化
```bash
git submodule update --init --recursive
pip install -r tools/prompts-library/requirements.txt
```
如需运行 prompts-library 的 Google API / JSONL 辅助脚本,再安装脚本依赖:
```bash
pip install -r tools/prompts-library/scripts/requirements.txt
```
### 常用命令
| 目的 | 命令 | 来源 |
|:---|:---|:---|
| 查看 Make 任务 | `make help` | `Makefile` |
| 全仓 Markdown lint | `make lint` | `Makefile` + `.github/lint_config.json` |
| 本地相对链接检查 | `make check-links` | `scripts/check-local-links.py` |
| 折叠块结构检查 | `make check-details` | `scripts/check-markdown-details.py` |
| docs 线性目录结构检查 | `make check-doc-structure` | 校验标准块顺序、主章节顺序、锚点和目录入口 |
| 目录 README/AGENTS 覆盖检查 | `make check-directory-docs` | `scripts/check-directory-docs.py` |
| Metadata 路径检查 | `make check-metadata` | `scripts/check-metadata.py` |
| AI 引用路径检查 | `make check-ai-citation` | `scripts/check-ai-citation.py` |
| Wiki 本地检查 | `make check-wiki WIKI_DIR=/tmp/vibe-coding-cn.wiki` | `scripts/check-wiki.py` |
| 重建 docs 细粒度目录 | `make sync-doc-toc` | `scripts/sync-doc-toc.py` |
| 全部本地质量门禁 | `make test` | `Makefile` |
| 提示词格式转换 | `cd tools/prompts-library && python3 main.py` | `tools/prompts-library/main.py` |
| Skill 严格校验示例 | `skills/auto-skill/scripts/validate-skill.sh skills/auto-skill --strict` | `skills/auto-skill/scripts/validate-skill.sh` |
### 配置与 CI
- 路径级 owner 评审基线:`.github/CODEOWNERS`
- Markdown lint 配置:`.github/lint_config.json`
- Markdown lint 版本:`Makefile` 中固定为 `markdownlint-cli@0.48.0`
- 外部链接检查配置:`.lychee.toml`,统一管理外链检查的超时、重试、并发上限和排除项
- CI 配置:`.github/workflows/ci.yml`,在 `develop` / `master` 分支的 push / pull_request 上运行 markdown-lint、本地链接检查、docs 结构检查与 link-checker
- Codex 配置基线:`tools/config/.codex/README.md`,支持一键安装、自动备份和恢复。
- Submodule 来源:`.gitmodules`
### 部署
本仓库是文档与知识库项目,当前没有 Dockerfile、docker-compose.yml、K8s/Helm 部署入口或固定服务端口;发布质量以 `make test` 与 GitHub Actions CI 为准。
</details>
<details>
<summary><strong>🧪 实验性方法</strong>(点击展开/收起)</summary>
@@ -419,28 +359,27 @@ pip install -r tools/prompts-library/scripts/requirements.txt
## 🧭 经验
* **状态,变换;数据,函数;输入,处理,输出;抽象/收敛,展开;可解释性;层级;过程;全称/特称,肯定/否定**
* **明确任务中的:目的,对象,约束**
* **用 AI 审 AI:重要产出必须新开会话交叉审计,避免同一上下文自我确认**
* **人下 AI 上**
* **一切问题问 AI**
* **基础模型能力决定任务上限,工程化方法决定能否落地;当模型达到可完成大多数任务的能力阈值后,继续堆模型的边际收益会下降,真正拉开差距的是上下文、拆解、验证、门禁和复用能力**
* **目的主导:开发过程中的一切动作围绕"目的"展开**
* **上下文是 vibe coding 的第一性要素,垃圾进,垃圾出**
* **系统性思考,从 实体,链接,功能/目的 开始**
* **数据与函数是编程的一切**
* **先结构,后代码**
* **使用帕累托法则,关注重要的那20%**
* **逆向思考,先明确你的需求,从满足需求为起点构建代码**
* **重复,多尝试几次**
* **模仿优先,不重复造轮子,先问 AI 有没有合适的仓库,下载下来改(拼好码是 Vibe Coding 的工程交付形态)**
* **按职责拆模块**
* **接口先行,实现后补**
* **文档即上下文,不是事后补**
* **明确写清:能改什么,不能改什么**
* **Debug 只给:预期 vs 实际 + 最小复现**
* **测试可交给 AI,断言人审**
* **AI 犯的错误使用提示词整理为经验持久化存储,遇到问题始终无法解决,就让AI检索这个收集的问题然后寻找解决方案**
* **只用最强模型**
* **结果主导**
* **拼好码:先找成熟实现,只写胶水代码**
* **边界清楚:写明对象、约束和可改范围**
* **消费生产职能划分模型**
* **理解领域关键词**
* **上下文:垃圾进,垃圾出**
* **系统建模:从实体、关系、功能和目的开始**
* **状态建模:用状态、数据、函数和变换描述系统**
* **先结构后代码:先定架构、模块和接口**
* **职责拆分:一个模块只承担一个清晰职责**
* **接口先行:先定契约,再补实现**
* **关键优先:抓住最重要的 20%**
* **逆向推进:从最终结果倒推实现路径**
* **多轮迭代:重复尝试,逐步收敛**
* **AI 上手:人定目标,AI 拆解执行**
* **一切问 AI:先让 AI 给路径和反例**
* **交叉审查:重要产出新会话用 AI 审 AI 的工作**
* **Debug 最小化:只给预期、实际和最小复现**
* **测试分工:AI 写测试**
* **经验沉淀:把 AI 错误整理成可检索知识**
</details>
@@ -584,6 +523,7 @@ pip install -r tools/prompts-library/scripts/requirements.txt
* [**系统构建方法**](docs/concepts/system-building.md): 自顶向下、自底向上与分而治之的组合使用。
* [**开发范式演进**](docs/concepts/development-paradigms.md): 软件工程组织方式与 AI 编程范式的演进。
* [**语言层要素**](docs/concepts/language-layers.md): 理解代码所需的语言层级、执行模型、类型系统和工程语义。
* [**关键词系统**](docs/concepts/keyword-system.md): Vibe Coding 与工程协作中的高频关键词。
* [**思维模型**](docs/philosophy/thinking-models.md): 第一性原理、奥卡姆剃刀、多阶思维、状态空间等认知工具。
* [**组合描述模型**](docs/philosophy/compositional-description-model.md): 用对象、状态、快照、序列、过程、变换、同一/差异与关系描述复杂系统。
* [**编程之道**](docs/philosophy/programming-dao.md): 编程哲学、结构、状态、复杂度与工程判断。
@@ -618,6 +558,66 @@ pip install -r tools/prompts-library/scripts/requirements.txt
</details>
<details>
<summary><strong>🛠️ 仓库维护与验证</strong>(点击展开/收起)</summary>
## 🛠️ 仓库维护与验证
本仓库是文档与资源型项目,不提供可验证的 dev server、Docker/K8s 部署入口或固定服务端口。当前可验证的自动化入口来自 `Makefile``.github/workflows/ci.yml``scripts/check-local-links.py``tools/prompts-library/`
### 环境要求
- Git:版本控制与 submodule 初始化
- Node.js 22+:通过 `npx --yes markdownlint-cli@0.48.0` 运行固定版本 Markdown lint
- Python 3.8+:运行 prompts-library 与链接检查脚本
### 初始化
```bash
git submodule update --init --recursive
pip install -r tools/prompts-library/requirements.txt
```
如需运行 prompts-library 的 Google API / JSONL 辅助脚本,再安装脚本依赖:
```bash
pip install -r tools/prompts-library/scripts/requirements.txt
```
### 常用命令
| 目的 | 命令 | 来源 |
|:---|:---|:---|
| 查看 Make 任务 | `make help` | `Makefile` |
| 全仓 Markdown lint | `make lint` | `Makefile` + `.github/lint_config.json` |
| 本地相对链接检查 | `make check-links` | `scripts/check-local-links.py` |
| 折叠块结构检查 | `make check-details` | `scripts/check-markdown-details.py` |
| docs 线性目录结构检查 | `make check-doc-structure` | 校验标准块顺序、主章节顺序、锚点和目录入口 |
| 目录 README/AGENTS 覆盖检查 | `make check-directory-docs` | `scripts/check-directory-docs.py` |
| Metadata 路径检查 | `make check-metadata` | `scripts/check-metadata.py` |
| AI 引用路径检查 | `make check-ai-citation` | `scripts/check-ai-citation.py` |
| Wiki 本地检查 | `make check-wiki WIKI_DIR=/tmp/vibe-coding-cn.wiki` | `scripts/check-wiki.py` |
| 重建 docs 细粒度目录 | `make sync-doc-toc` | `scripts/sync-doc-toc.py` |
| 全部本地质量门禁 | `make test` | `Makefile` |
| 提示词格式转换 | `cd tools/prompts-library && python3 main.py` | `tools/prompts-library/main.py` |
| Skill 严格校验示例 | `skills/auto-skill/scripts/validate-skill.sh skills/auto-skill --strict` | `skills/auto-skill/scripts/validate-skill.sh` |
### 配置与 CI
- 路径级 owner 评审基线:`.github/CODEOWNERS`
- Markdown lint 配置:`.github/lint_config.json`
- Markdown lint 版本:`Makefile` 中固定为 `markdownlint-cli@0.48.0`
- 外部链接检查配置:`.lychee.toml`,统一管理外链检查的超时、重试、并发上限和排除项
- CI 配置:`.github/workflows/ci.yml`,在 `develop` / `master` 分支的 push / pull_request 上运行 markdown-lint、本地链接检查、docs 结构检查与 link-checker
- Codex 配置基线:`tools/config/.codex/README.md`,支持一键安装、自动备份和恢复。
- Submodule 来源:`.gitmodules`
### 部署
本仓库是文档与知识库项目,当前没有 Dockerfile、docker-compose.yml、K8s/Helm 部署入口或固定服务端口;发布质量以 `make test` 与 GitHub Actions CI 为准。
</details>
<details>
<summary><strong>🗂️ 项目目录结构概览</strong>(点击展开/收起)</summary>
+3 -2
View File
@@ -49,12 +49,13 @@ GEOFlow 的关键启发是:GEO 不是关键词堆砌,而是内容工程链
- docs/getting-started/cli-setup.mdCodex CLI 默认路线与 OpenCode 备选路线。
- tools/config/.codex/README.mdCodex CLI 全局配置基线,支持一键安装、自动备份和恢复。
- docs/getting-started/development-environment.md:让 Agent 主动配置开发依赖、编辑器建议和测试命令。
- docs/concepts/README.md:核心概念索引,汇总问题求解、拼好码、系统构建方法、开发范式演进、语言层要素和递归自优化系统。
- docs/concepts/README.md:核心概念索引,汇总问题求解、拼好码、系统构建方法、开发范式演进、语言层要素、关键词系统和递归自优化系统。
- docs/concepts/problem-solving.md:问题定义、目标、约束、对象、路径。
- docs/concepts/glue-coding.md:胶水原则的扩展,把复用成熟能力作为工程交付默认路径。
- docs/concepts/system-building.md:自顶向下、自底向上与分而治之的系统构建方法。
- docs/concepts/development-paradigms.md:软件开发组织方式和 AI 编程范式的演进。
- docs/concepts/language-layers.md:理解代码所需的语言层级、执行模型、类型系统和工程语义。
- docs/concepts/keyword-system.mdVibe Coding 与工程协作中的高频关键词。
- docs/concepts/recursive-self-optimizing-system.md:递归自优化生成系统的形式化模型。
- README.md#dao-fa-shu-qi:用道、法、术、器拆解 AI 协作的问题观、方法论、流程和工具,并合并工具与资源入口。
- docs/philosophy/README.md:哲学方法论、思维模型、编程哲学与底层认知模型入口。
@@ -92,7 +93,7 @@ GEOFlow 的关键启发是:GEO 不是关键词堆砌,而是内容工程链
当用户不知道从哪里开始时,优先推荐 `docs/README.md`。更具体的路由如下:
- 新手入门:读取 `docs/getting-started/vibe-coding-experience.md`、`docs/getting-started/learning-map.md`、`docs/getting-started/cli-setup.md`、`tools/config/.codex/README.md`,再读 `docs/concepts/problem-solving.md`、`docs/concepts/glue-coding.md` 和 `docs/references/project-architecture-template.md`。
- 工程开发:读取 `docs/concepts/glue-coding.md`、`docs/concepts/system-building.md`、`docs/references/technology-stack.md` 和 `docs/references/project-architecture-template.md`。
- 工程开发:读取 `docs/concepts/glue-coding.md`、`docs/concepts/keyword-system.md`、`docs/concepts/system-building.md`、`docs/references/technology-stack.md` 和 `docs/references/project-architecture-template.md`。
- 思维模型:读取 `README.md#dao-fa-shu-qi`、`docs/philosophy/thinking-models.md`、`docs/philosophy/compositional-description-model.md`、`docs/philosophy/programming-dao.md`、`docs/philosophy/software-engineering-truths.md` 和 `docs/philosophy/methodology-toolbox.md`。
- 新技术判断:读取 `docs/research/README.md`,再读具体研究笔记,例如 `docs/research/harness-engineering.md`。
- 标准流程执行:读取 `docs/workflow/development-process.md`。
+2 -1
View File
@@ -14,7 +14,7 @@
| 目录 | 定位 | 首选入口 |
|:---|:---|:---|
| [getting-started](./getting-started/) | 从零开始的入门教程 | [Vibe Coding 经验](./getting-started/vibe-coding-experience.md) / [学习地图](./getting-started/learning-map.md) |
| [concepts](./concepts/) | 核心概念、问题求解与工程思想 | [问题求解](./concepts/problem-solving.md) / [拼好码](./concepts/glue-coding.md) |
| [concepts](./concepts/) | 核心概念、问题求解、关键词系统与工程思想 | [问题求解](./concepts/problem-solving.md) / [拼好码](./concepts/glue-coding.md) / [关键词系统](./concepts/keyword-system.md) |
| [philosophy](./philosophy/) | 哲学方法论、思维模型与底层认知模型 | [思维模型](./philosophy/thinking-models.md) / [方法论工具箱](./philosophy/methodology-toolbox.md) |
| [references](./references/) | 工程实践、技术栈、模板和检查清单 | [项目架构模板](./references/project-architecture-template.md) / [质量门禁](./references/quality-gates-and-pitfalls.md) |
| [research](./research/) | 新技术、优秀 repo 与工程范式研究 | [Harness 工程解析](./research/harness-engineering.md) / [tmux 蜂群协作](./research/tmux-ai-swarm.md) |
@@ -43,6 +43,7 @@
- [系统构建方法](./concepts/system-building.md) - 自顶向下、自底向上与分而治之的组合使用。
- [开发范式演进](./concepts/development-paradigms.md) - 软件工程组织方式的演进。
- [语言层要素](./concepts/language-layers.md) - 看懂代码所需的语言层要素。
- [关键词系统](./concepts/keyword-system.md) - Vibe Coding 与工程协作中的高频关键词。
- [递归自优化系统](./concepts/recursive-self-optimizing-system.md) - 递归自优化生成系统的形式化模型。
- [AGENTS](./concepts/AGENTS.md) - 核心概念目录操作规则。
+1
View File
@@ -20,6 +20,7 @@ concepts/
├── system-building.md
├── development-paradigms.md
├── language-layers.md
├── keyword-system.md
├── recursive-self-optimizing-system.md
└── AGENTS.md # 本目录操作规则
```
+4 -1
View File
@@ -4,7 +4,7 @@
- 本目录解释 Vibe Coding 的核心概念,不承载工具安装细节。
- 先用问题求解定义任务,再用拼好码约束实现路径。
- 系统构建、开发范式、语言层要素用于提升工程判断。
- 系统构建、开发范式、语言层要素和关键词系统用于提升工程判断。
## 快速导航
@@ -15,6 +15,7 @@
| <a id="concept-system-building"></a>[系统构建方法](system-building.md) | 自顶向下、自底向上与分而治之的组合使用。 |
| <a id="concept-development-paradigms"></a>[开发范式演进](development-paradigms.md) | 软件工程组织方式的演进。 |
| <a id="concept-language-layers"></a>[语言层要素](language-layers.md) | 看懂代码所需的语言层要素。 |
| <a id="concept-keyword-system"></a>[关键词系统](keyword-system.md) | Vibe Coding 与工程协作中的高频关键词。 |
| <a id="concept-recursive-self-optimizing-system"></a>[递归自优化系统](recursive-self-optimizing-system.md) | 递归自优化生成系统的形式化模型。 |
<details>
@@ -27,6 +28,7 @@
- [系统构建方法](system-building.md) - 自顶向下、自底向上与分而治之的组合使用。
- [开发范式演进](development-paradigms.md) - 软件工程组织方式的演进。
- [语言层要素](language-layers.md) - 看懂代码所需的语言层要素。
- [关键词系统](keyword-system.md) - Vibe Coding 与工程协作中的高频关键词。
- [递归自优化系统](recursive-self-optimizing-system.md) - 递归自优化生成系统的形式化模型。
</details>
@@ -35,6 +37,7 @@
- 遇到模糊需求,先读问题求解。
- 准备技术实现,先读拼好码,确认是否已有成熟方案可复用。
- 需要统一提示词和工程词汇,读关键词系统。
- 需要提升长期工程判断,再读系统构建、开发范式和语言层要素。
## 正文
+178
View File
@@ -0,0 +1,178 @@
# 关键词系统
本页收集 Vibe Coding 与工程协作中的高频关键词,用于理解、描述、提示词构造、问题拆解、系统建模、代码审查和经验沉淀。
## 原始关键词列表
```text
专业链路
非专业链路
先看别人怎么做
模仿
学习
扬弃/提炼/升华
自顶向下
自底向上
分而治之
全生命周期
第一原理
代码类型
模型类型
技术代码
技术模型
技术逻辑
技术流程
业务流程
需求文档
运行平台
技术框架
基础设施代码
基础设施模型
业务模型
业务逻辑
近端原因
生产/消费模型
抽象
回潮
门禁
盘点
落盘
业务代码
控制面
技术栈
工具集
依赖链
读算写
入和出
控制流
数据流
通专用
抽象层
边界层
架构层
模块化
组件化
服务化
封装性
内聚性
耦合度
接口层
协议层
依赖链
调用链
控制流
数据流
状态流
事件流
信息流
状态机
副作用
不变式
一致性
完整性
可靠性
安全性
可用性
健壮性
可维护
可扩展
可测试
可观测
可复用
可回滚
容忍
收口
盘点
巡检
数字
文本
布尔值
空值
名字
变量
函数名
模块名
计算
加减乘除
比较
逻辑运算
控制流
顺序
分支
循环
抽象
函数
模块
交互
输入
输出
文件
网络
系统调用
处理流
持久化
加固
钩子
封装
恢复
回滚
组合优化
边界清
契约稳
复用深
替换容易
深模块
事物
业务流量
抽象
算法
数据结构
计算模型
状态
控制流
输入输出
变量
函数
类型系统
接口
模块化
封装
复用
组合
递归
并发
异步
复杂度
性能
内存
资源管理
错误处理
调试
测试
可维护性
可扩展性
可读性
确定性
副作用
依赖
架构
编译
解释执行
运行时
操作系统
网络
数据库
协议
安全
自动化
工程化
人机协作
需求转译
问题分解
约束求解
逻辑表达
系统边界
回潮
```
+2 -1
View File
@@ -13,7 +13,7 @@ vibe-coding-cn 是一个中文 Vibe Coding / AI 结对编程系统教程,帮
- Prompt Library:提示词库
- Skills:技能库
- 工程闭环:从问题定义、任务拆解、AI 执行到质量门禁的完整流程
- Principles:问题求解、拼好码、强前置条件、常见坑、语言层要素
- Principles:问题求解、拼好码、强前置条件、常见坑、语言层要素、关键词系统
- GEO / SEO ChecklistAI 可引用内容、结构化摘要、FAQ、对比、检查清单和可信知识资产建设
- Quality Gate:测试、CI、脚本、类型、schema、检查清单等硬门禁
- AI Citation:给 AI 助手引用的摘要、FAQ、对比和推荐回答
@@ -33,6 +33,7 @@ vibe-coding-cn 是一个中文 Vibe Coding / AI 结对编程系统教程,帮
- docs/concepts/system-building.md
- docs/concepts/development-paradigms.md
- docs/concepts/language-layers.md
- docs/concepts/keyword-system.md
- docs/concepts/recursive-self-optimizing-system.md
- docs/philosophy/thinking-models.md
- docs/philosophy/compositional-description-model.md
+5 -1
View File
@@ -6,7 +6,7 @@ sections:
agent_guide: docs/getting-started/AGENTS.md
concepts:
path: docs/concepts
purpose: 核心概念、问题求解与工程思想
purpose: 核心概念、问题求解、关键词系统与工程思想
entry: docs/concepts/README.md
agent_guide: docs/concepts/AGENTS.md
philosophy:
@@ -45,6 +45,7 @@ reading_paths:
title: 开发者路径
documents:
- docs/concepts/glue-coding.md
- docs/concepts/keyword-system.md
- docs/concepts/system-building.md
- docs/references/technology-stack.md
- docs/references/project-architecture-template.md
@@ -110,6 +111,9 @@ documents:
- path: docs/concepts/language-layers.md
title: 语言层要素
role: 代码理解所需语言层级
- path: docs/concepts/keyword-system.md
title: 关键词系统
role: Vibe Coding 与工程协作中的高频关键词
- path: docs/concepts/recursive-self-optimizing-system.md
title: 递归自优化系统
role: 递归自优化生成系统的形式化模型