docs: readme - improve structure and anchors
This commit is contained in:
tukuaiai
parent
0bfd3d4f0d
commit
f7b827b4f6
57
README.md
57
README.md
|
|
@ -52,13 +52,13 @@
|
|||
<a href="./libs/external/chat-vault/README.md"><img src="https://img.shields.io/badge/🔐_Chat_Vault-AI会话库-gold?style=for-the-badge" alt="Chat Vault"></a>
|
||||
</p>
|
||||
|
||||
[📋 工具资源](#-器-工具与资源)
|
||||
[🚀 从零开始](#-从零开始)
|
||||
[🎯 原仓库翻译](#-原仓库翻译)
|
||||
[⚙️ 完整设置流程](#️-完整设置流程)
|
||||
[📞 联系方式](#-联系方式)
|
||||
[✨ 支持项目](#-支持项目)
|
||||
[🤝 参与贡献](#-参与贡献)
|
||||
[📋 工具与资源](#tools)
|
||||
[🚀 从零开始](#getting-started)
|
||||
[🎯 原仓库翻译](#translation)
|
||||
[⚙️ 完整设置流程](#setup)
|
||||
[📞 联系方式](#contact)
|
||||
[✨ 支持项目](#support)
|
||||
[🤝 参与贡献](#contributing)
|
||||
|
||||
本仓库的 AI 解读链接：[zread.ai/tukuaiai/vibe-coding-cn](https://zread.ai/tukuaiai/vibe-coding-cn/1-overview)
|
||||
|
||||
|
|
@ -103,6 +103,8 @@
|
|||
|
||||
---
|
||||
|
||||
<a id="getting-started"></a>
|
||||
|
||||
## 🚀 从零开始
|
||||
|
||||
完全新手？按顺序完成以下步骤：
|
||||
|
|
@ -179,6 +181,8 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
<details open>
|
||||
<summary><strong>🔮 哲学方法论工具箱</strong></summary>
|
||||
|
||||
## 🔮 哲学方法论工具箱
|
||||
|
||||
> **把 Vibe 系统化为可验证、可迭代、可收敛的工程产出**
|
||||
|
||||
23 种哲学方法论 + Python 工具 + 可复制提示词，覆盖：
|
||||
|
|
@ -195,11 +199,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
|
||||
👉 [深入了解哲学方法论工具箱](./documents/05-哲学与方法论/README.md)
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## 🖼️ 概览
|
||||
### 🖼️ 概览
|
||||
|
||||
**Vibe Coding** 是一个与 AI 结对编程的终极工作流程，旨在帮助开发者丝滑地将想法变为现实。本指南详细介绍了从项目构思、技术选型、实施规划到具体开发、调试和扩展的全过程，强调以**规划驱动**和**模块化**为核心，避免让 AI 失控导致项目混乱。
|
||||
|
||||
|
|
@ -210,6 +210,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
<details open>
|
||||
<summary><strong>🔑 元方法论 (Meta-Methodology)</strong></summary>
|
||||
|
||||
## 🔑 元方法论 (Meta-Methodology)
|
||||
|
||||
该思想的核心是构建一个能够**自我优化**的 AI 系统。其递归本质可分解为以下步骤：
|
||||
|
||||
|
|
@ -243,7 +244,9 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
<details open>
|
||||
<summary><strong>🧭 经验</strong></summary>
|
||||
|
||||
## 经验
|
||||
## 🧭 经验
|
||||
|
||||
### 心法
|
||||
|
||||
* **人下 AI 上**
|
||||
* **凡是 AI 能做的，就不要人工做**
|
||||
|
|
@ -260,6 +263,9 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
* **逆向思考，先明确你的需求，从需求逆向构建代码**
|
||||
* **重复，多试几次，实在不行重新开个窗口，**
|
||||
* **专注，极致的专注可以击穿代码，一次只做一件事（神人除外）**
|
||||
|
||||
### 方法
|
||||
|
||||
* **一句话目标 + 非目标**
|
||||
* **正交性（这个分场景）**
|
||||
* **能抄不写，不重复造轮子，先问 AI 有没有合适的仓库，下载下来改（glue coding全新范式）**
|
||||
|
|
@ -268,6 +274,9 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
* **接口先行，实现后补**
|
||||
* **一次只改一个模块**
|
||||
* **文档即上下文，不是事后补**
|
||||
|
||||
### 交付与复盘
|
||||
|
||||
* 明确写清：**能改什么，不能改什么**
|
||||
* Debug 只给：**预期 vs 实际 + 最小复现**
|
||||
* 测试可交给 AI，**断言人审**
|
||||
|
|
@ -276,6 +285,8 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
|
||||
</details>
|
||||
|
||||
<a id="tools"></a>
|
||||
|
||||
<details open>
|
||||
<summary><strong>📋 工具与资源</strong></summary>
|
||||
|
||||
|
|
@ -372,7 +383,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
<details>
|
||||
<summary><strong>项目目录结构概览</strong></summary>
|
||||
|
||||
### 项目目录结构概览
|
||||
## 项目目录结构概览
|
||||
|
||||
本项目 `vibe-coding-cn` 的核心结构主要围绕知识管理、AI 提示词的组织与自动化展开。以下是经过整理和简化的目录树及各部分说明：
|
||||
|
||||
|
|
@ -450,6 +461,8 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真
|
|||
|
||||
</details>
|
||||
|
||||
</details>
|
||||
|
||||
## 📺 演示与产出
|
||||
|
||||
一句话：Vibe Coding = **规划驱动 + 上下文固定 + AI 结对执行**，让「从想法到可维护代码」变成一条可审计的流水线，而不是一团无法迭代的巨石文件。
|
||||
|
|
@ -544,7 +557,9 @@ graph TB
|
|||
</details>
|
||||
|
||||
<details>
|
||||
<summary>📈 性能基准 (可选)</summary>
|
||||
<summary><strong>📈 性能基准 (可选)</strong></summary>
|
||||
|
||||
## 📈 性能基准 (可选)
|
||||
|
||||
本仓库定位为「流程与提示词」而非性能型代码库，建议跟踪下列可观测指标（当前主要依赖人工记录，可在 `progress.md` 中打分/留痕）：
|
||||
|
||||
|
|
@ -579,6 +594,8 @@ gantt
|
|||
|
||||
---
|
||||
|
||||
<a id="translation"></a>
|
||||
|
||||
## 🎯 原仓库翻译
|
||||
|
||||
> 以下内容翻译自原仓库 [EnzeD/vibe-coding](https://github.com/EnzeD/vibe-coding)
|
||||
|
|
@ -595,9 +612,13 @@ gantt
|
|||
|
||||
---
|
||||
|
||||
<a id="setup"></a>
|
||||
|
||||
<details>
|
||||
<summary><strong>⚙️ 完整设置流程</strong></summary>
|
||||
|
||||
## ⚙️ 完整设置流程
|
||||
|
||||
<details>
|
||||
<summary><strong>1. 游戏设计文档（Game Design Document）</strong></summary>
|
||||
|
||||
|
|
@ -767,6 +788,8 @@ gantt
|
|||
|
||||
---
|
||||
|
||||
<a id="contact"></a>
|
||||
|
||||
## 📞 联系方式
|
||||
|
||||
- **GitHub**: [tukuaiai](https://github.com/tukuaiai)
|
||||
|
|
@ -778,6 +801,8 @@ gantt
|
|||
|
||||
---
|
||||
|
||||
<a id="support"></a>
|
||||
|
||||
## ✨ 支持项目
|
||||
|
||||
救救孩子，感谢了，好人一生平安🙏🙏🙏
|
||||
|
|
@ -814,6 +839,8 @@ gantt
|
|||
|
||||
---
|
||||
|
||||
<a id="contributing"></a>
|
||||
|
||||
## 🤝 参与贡献
|
||||
|
||||
我们热烈欢迎各种形式的贡献。如果您对本项目有任何想法或建议，请随时开启一个 [Issue](https://github.com/tukuaiai/vibe-coding-cn/issues) 或提交一个 [Pull Request](https://github.com/tukuaiai/vibe-coding-cn/pulls)。
|
||||
|
|
|
|||
Loading…
Reference in New Issue