mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-13 10:58:05 +00:00
docs: add directory readmes and agent guides
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
# Concepts 目录 Agent 指南
|
||||
|
||||
## 目录职责
|
||||
|
||||
`docs/concepts/` 存放项目的核心概念与工程认知框架。
|
||||
|
||||
这里的文档回答:
|
||||
|
||||
- Vibe Coding 的基本概念是什么。
|
||||
- 新手如何定义问题、拆解问题和构建系统。
|
||||
- 工程方法如何从经验沉淀为可复用模型。
|
||||
|
||||
## 文件地图
|
||||
|
||||
```text
|
||||
concepts/
|
||||
├── README.md # 核心概念索引
|
||||
├── AGENTS.md # 本目录操作规则
|
||||
├── 拼好码.md # 复用优先与胶水原则
|
||||
├── 问题求解.md # 问题定义与求解框架
|
||||
├── 系统构建方法.md # 自顶向下、自底向上、分而治之
|
||||
├── 开发范式演进.md # 软件开发范式演进
|
||||
├── 语言层要素.md # 代码理解所需语言层要素
|
||||
└── 递归自优化系统.md # 递归自优化生成系统形式化
|
||||
```
|
||||
|
||||
## 修改规则
|
||||
|
||||
- 新增概念文档时,必须同步更新 `README.md`。
|
||||
- 重命名文件时,必须同步更新全仓链接和 `metadata/redirects.yml`。
|
||||
- 概念文档应优先使用稳定术语,避免同一概念多种叫法并存。
|
||||
- 不把一次性操作步骤放入本目录;操作型内容应放入 `docs/getting-started/`
|
||||
或 `docs/references/`。
|
||||
|
||||
## 质量要求
|
||||
|
||||
- 每个概念先说明它解决的问题。
|
||||
- 尽量给出使用场景、判断标准和简单例子。
|
||||
- 不确定的外部事实必须标注 TODO 或迁移到 `docs/research/`。
|
||||
@@ -0,0 +1,27 @@
|
||||
# 核心概念
|
||||
|
||||
> `concepts/` 存放 Vibe Coding 的核心概念、问题求解框架、工程范式与系统构建方法。
|
||||
|
||||
## 文档列表
|
||||
|
||||
- [拼好码](拼好码.md) - 复用成熟能力,用胶水代码连接、编排、适配业务流程。
|
||||
- [问题求解](问题求解.md) - 用目标、现状、差距、标准、约束、对象和路径定义问题。
|
||||
- [系统构建方法](系统构建方法.md) - 自顶向下、自底向上与分而治之的组合使用。
|
||||
- [开发范式演进](开发范式演进.md) - 从面向过程到云原生的工程组织方式演进。
|
||||
- [语言层要素](语言层要素.md) - 看懂代码需要掌握的语言层要素。
|
||||
- [递归自优化系统](递归自优化系统.md) - 递归自优化生成系统的形式化模型。
|
||||
|
||||
## 使用顺序
|
||||
|
||||
建议先读:
|
||||
|
||||
1. [问题求解](问题求解.md)
|
||||
2. [拼好码](拼好码.md)
|
||||
3. [系统构建方法](系统构建方法.md)
|
||||
4. [开发范式演进](开发范式演进.md)
|
||||
|
||||
## 维护规则
|
||||
|
||||
- 新增核心概念时,必须补充到本文档索引。
|
||||
- 文档命名应短、稳定、可引用。
|
||||
- 概念类文档优先解释“是什么、解决什么问题、如何使用”。
|
||||
Reference in New Issue
Block a user