From 28bfaeeee3698d1281ed79fcff51bc112e4658d8 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Sat, 28 Feb 2026 06:58:54 +0800 Subject: [PATCH] docs: documents - update structure and navigation --- AGENTS.md | 14 ++++--- README.md | 76 +++++++++++++++++++------------------- assets/documents/AGENTS.md | 17 +++++---- assets/documents/README.md | 34 ++++++++--------- 4 files changed, 73 insertions(+), 68 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 18236bb..8f58748 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -144,11 +144,13 @@ git push origin develop │ │ ├── config.toml # Codex CLI 配置文件 │ │ └── AGENTS.md # Codex/Agent 指南（本目录） │ ├── documents/ # 文档库 -│ │ ├── 05-哲学与方法论/ # 最高思想纲领与方法论 -│ │ ├── 00-基础指南/ # 核心原则与底层逻辑 -│ │ ├── 01-入门指南/ # 从零开始教程 -│ │ ├── 02-方法论/ # 具体工具与技巧 -│ │ └── 03-实战/ # 项目实战案例 +│ │ ├── principles/ # 原则与思想（fundamentals + philosophy） +│ │ │ ├── fundamentals/ # 原 00-基础指南 +│ │ │ └── philosophy/ # 原 05-哲学与方法论 +│ │ ├── guides/ # 入门与方法（getting-started + playbook） +│ │ │ ├── getting-started/ # 原 01-入门指南 +│ │ │ └── playbook/ # 原 02-方法论 +│ │ └── case-studies/ # 原 03-实战 │ ├── prompts/ # 提示词库（指向云端表格） │ │ ├── README.md # 在线表格链接 │ │ └── AGENTS.md # prompts/ 目录规则 @@ -282,7 +284,7 @@ bash assets/repo/backups/一键备份.sh ### Core Directories - **`assets/prompts/`**: 提示词库入口（指向云端表格） - **`assets/skills/`**: 扁平化技能库（详见 assets/skills/README.md） -- **`assets/documents/`**: 知识库（05-哲学与方法论、00-基础指南、01-入门指南、02-方法论、03-实战） +- **`assets/documents/`**: 知识库（principles、guides、case-studies） - **`assets/`**: 外部资源（在线表格）入口与使用说明 - **`assets/repo/prompts-library/`**: Excel ↔ Markdown 转换工具 - **`assets/repo/chat-vault/`**: AI 聊天记录保存工具 diff --git a/README.md b/README.md index b7a5cef..6547936 100644 --- a/README.md +++ b/README.md @@ -31,19 +31,19 @@

- 哲学与方法论 - 核心哲学 - 胶水编程 - Canvas白板驱动开发 - 从零开始 - 血的教训 - 语言层要素 - 常见坑汇总 - 强前置条件约束 + 哲学与方法论 + 核心哲学 + 胶水编程 + Canvas白板驱动开发 + 从零开始 + 血的教训 + 语言层要素 + 常见坑汇总 + 强前置条件约束 信息源聚合 - 元方法论 - 编程之道 - 实战案例 + 元方法论 + 编程之道 + 实战案例 工具集 提示词精选 skills技能大全 @@ -109,11 +109,11 @@ 完全新手？按顺序完成以下步骤： -0. [00-Vibe Coding 哲学原理](./assets/documents/01-入门指南/00-Vibe%20Coding%20哲学原理.md) - 理解核心理念 -1. [01-网络环境配置](./assets/documents/01-入门指南/01-网络环境配置.md) - 配置网络访问 -2. [02-开发环境搭建](./assets/documents/01-入门指南/02-开发环境搭建.md) - 复制提示词给 AI，让 AI 指导你搭建环境 -3. [03-IDE配置](./assets/documents/01-入门指南/03-IDE配置.md) - 配置 VS Code 编辑器 -4. [04-OpenCode-CLI配置](./assets/documents/01-入门指南/04-OpenCode-CLI配置.md) - 免费 AI CLI 工具，支持 GLM-4.7/MiniMax M2.1 等模型 +0. [00-Vibe Coding 哲学原理](./assets/documents/guides/getting-started/00-Vibe%20Coding%20哲学原理.md) - 理解核心理念 +1. [01-网络环境配置](./assets/documents/guides/getting-started/01-网络环境配置.md) - 配置网络访问 +2. [02-开发环境搭建](./assets/documents/guides/getting-started/02-开发环境搭建.md) - 复制提示词给 AI，让 AI 指导你搭建环境 +3. [03-IDE配置](./assets/documents/guides/getting-started/03-IDE配置.md) - 配置 VS Code 编辑器 +4. [04-OpenCode-CLI配置](./assets/documents/guides/getting-started/04-OpenCode-CLI配置.md) - 免费 AI CLI 工具，支持 GLM-4.7/MiniMax M2.1 等模型 @@ -136,7 +136,7 @@ > 一句话：用“生成器/优化器”的递归闭环，构建一个能持续自我优化的 AI 系统。 > -> 延伸阅读：[A Formalization of Recursive Self-Optimizing Generative Systems](./assets/documents/00-基础指南/A%20Formalization%20of%20Recursive%20Self-Optimizing%20Generative%20Systems.md) +> 延伸阅读：[A Formalization of Recursive Self-Optimizing Generative Systems](./assets/documents/principles/fundamentals/A%20Formalization%20of%20Recursive%20Self-Optimizing%20Generative%20Systems.md) ### 核心角色 - **α-提示词（生成器）**：一个“母体”提示词，其唯一职责是生成其他提示词或技能。 @@ -166,7 +166,7 @@ | 🧩 复杂性爆炸 | ✅ 每个模块都是久经考验的轮子 | | 🎓 门槛过高 | ✅ 你只需要描述"连接方式" | -👉 [深入了解胶水编程](./assets/documents/00-基础指南/胶水编程.md) +👉 [深入了解胶水编程](./assets/documents/principles/fundamentals/胶水编程.md) @@ -187,7 +187,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 **核心理念**：图形是第一公民，代码是白板的序列化形式。 -👉 [深入了解Canvas白板驱动开发](./assets/documents/02-方法论/图形化AI协作-Canvas白板驱动开发.md) +👉 [深入了解Canvas白板驱动开发](./assets/documents/guides/playbook/图形化AI协作-Canvas白板驱动开发.md) @@ -208,7 +208,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 **核心突破**：AI 不再是孤立的，而是可以互相感知、通讯、控制的集群。 -👉 [深入了解AI蜂群协作](./assets/documents/02-方法论/AI蜂群协作-tmux多Agent协作系统.md) +👉 [深入了解AI蜂群协作](./assets/documents/guides/playbook/AI蜂群协作-tmux多Agent协作系统.md) @@ -229,7 +229,7 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 **核心理念**：哲学不是空谈，是可落地的工程方法。 -👉 [深入了解哲学方法论工具箱](./assets/documents/05-哲学与方法论/README.md) +👉 [深入了解哲学方法论工具箱](./assets/documents/principles/philosophy/README.md) @@ -311,12 +311,12 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 * [**第三方系统提示词学习库**](https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools): 用于学习和参考其他 AI 工具的系统提示词。 * [**Skills 制作器**](https://github.com/yusufkaraaslan/Skill_Seekers): 可根据需求生成定制化 Skills 的工具。 * [**元提示词**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 用于生成提示词的高级提示词。 -* [**通用项目架构模板**](./assets/documents/00-基础指南/通用项目架构模板.md): 可用于快速搭建标准化的项目目录结构。 +* [**通用项目架构模板**](./assets/documents/principles/fundamentals/通用项目架构模板.md): 可用于快速搭建标准化的项目目录结构。 * [**元技能：Skills 的 Skills**](./assets/skills/skills-skills/SKILL.md): 用于生成 Skills 的元技能。 * [**SOP 生成 Skill**](./assets/skills/sop-generator/SKILL.md): 将资料/需求整理为可执行 SOP 的技能。 -* [**tmux快捷键大全**](./assets/documents/02-方法论/tmux快捷键大全.md): tmux 的快捷键参考文档。 -* [**LazyVim快捷键大全**](./assets/documents/02-方法论/LazyVim快捷键大全.md): LazyVim 的快捷键参考文档。 -* [**手机远程 Vibe Coding**](./assets/documents/02-方法论/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md): 基于 frp 实现手机 SSH 远程控制本地电脑进行 Vibe Coding。 +* [**tmux快捷键大全**](./assets/documents/guides/playbook/tmux快捷键大全.md): tmux 的快捷键参考文档。 +* [**LazyVim快捷键大全**](./assets/documents/guides/playbook/LazyVim快捷键大全.md): LazyVim 的快捷键参考文档。 +* [**手机远程 Vibe Coding**](./assets/documents/guides/playbook/关于手机ssh任意位置链接本地计算机，基于frp实现的方法.md): 基于 frp 实现手机 SSH 远程控制本地电脑进行 Vibe Coding。 ### 外部教程与资源 @@ -330,14 +330,14 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 ### 项目内部文档 -* [**胶水编程 (Glue Coding)**](./assets/documents/00-基础指南/): 软件工程的圣杯与银弹，Vibe Coding 的终极进化形态。 +* [**胶水编程 (Glue Coding)**](./assets/documents/principles/fundamentals/): 软件工程的圣杯与银弹，Vibe Coding 的终极进化形态。 * [**Chat Vault**](./assets/repo/chat-vault/): AI 聊天记录保存工具，支持 Codex/Kiro/Gemini/Claude CLI。 * [**prompts-library 工具说明**](./assets/repo/prompts-library/): 支持 Excel 与 Markdown 格式互转，包含数百个精选提示词。 * [**编程提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 适用于 Vibe Coding 流程的专用提示词（云端表格）。 -* [**系统提示词构建原则**](./assets/documents/00-基础指南/系统提示词构建原则.md): 构建高效 AI 系统提示词的综合指南。 -* [**开发经验总结**](./assets/documents/00-基础指南/开发经验.md): 变量命名、文件结构、编码规范、架构原则等。 -* [**通用项目架构模板**](./assets/documents/00-基础指南/通用项目架构模板.md): 多种项目类型的标准目录结构。 -* [**Augment MCP 配置文档**](./assets/documents/02-方法论/auggie-mcp配置文档.md): Augment 上下文引擎配置说明。 +* [**系统提示词构建原则**](./assets/documents/principles/fundamentals/系统提示词构建原则.md): 构建高效 AI 系统提示词的综合指南。 +* [**开发经验总结**](./assets/documents/principles/fundamentals/开发经验.md): 变量命名、文件结构、编码规范、架构原则等。 +* [**通用项目架构模板**](./assets/documents/principles/fundamentals/通用项目架构模板.md): 多种项目类型的标准目录结构。 +* [**Augment MCP 配置文档**](./assets/documents/guides/playbook/auggie-mcp配置文档.md): Augment 上下文引擎配置说明。 * [**系统提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): AI 开发的系统提示词，含多版本开发规范（云端表格）。 * [**外部资源（在线表格）**](./assets/README.md): 外部资源的唯一真相源（按类型分表），本地 Markdown 保留为历史参考。 @@ -383,11 +383,13 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 │ │ ├── config.toml # Codex CLI 配置文件 │ │ └── AGENTS.md # Codex/Agent 指南（本目录） │ ├── documents/ # 文档库 -│ │ ├── 05-哲学与方法论/ # 最高思想纲领与方法论 -│ │ ├── 00-基础指南/ # 核心原则与底层逻辑 -│ │ ├── 01-入门指南/ # 从零开始教程 -│ │ ├── 02-方法论/ # 具体工具与技巧 -│ │ └── 03-实战/ # 项目实战案例 +│ │ ├── principles/ # 原则与思想（fundamentals + philosophy） +│ │ │ ├── fundamentals/ # 原 00-基础指南 +│ │ │ └── philosophy/ # 原 05-哲学与方法论 +│ │ ├── guides/ # 入门与方法（getting-started + playbook） +│ │ │ ├── getting-started/ # 原 01-入门指南 +│ │ │ └── playbook/ # 原 02-方法论 +│ │ └── case-studies/ # 原 03-实战 │ ├── prompts/ # 提示词库（指向云端表格） │ │ ├── README.md # 在线表格链接 │ │ └── AGENTS.md # prompts/ 目录规则 @@ -454,7 +456,7 @@ assets/prompts/ assets/skills/ README.md # skills 总览与索引 assets/documents/ - 00-基础指南/代码组织.md, 00-基础指南/通用项目架构模板.md, 00-基础指南/开发经验.md, 00-基础指南/系统提示词构建原则.md 等知识库 + principles/fundamentals/*, principles/philosophy/*, guides/*, case-studies/* 等知识库 assets/ README.md # 外部资源（在线表格）唯一真相源入口 assets/repo/backups/ diff --git a/assets/documents/AGENTS.md b/assets/documents/AGENTS.md index e117aa1..c9eb73c 100644 --- a/assets/documents/AGENTS.md +++ b/assets/documents/AGENTS.md @@ -8,11 +8,13 @@ ``` assets/documents/ -├── 05-哲学与方法论/ # 最高思想纲领 -├── 00-基础指南/ # 核心原则与底层逻辑 -├── 01-入门指南/ # 从零开始教程 -├── 02-方法论/ # 具体工具与技巧 -└── 03-实战/ # 项目实战案例 +├── principles/ # 原则与思想（fundamentals + philosophy） +│ ├── fundamentals/ # 原 00-基础指南 +│ └── philosophy/ # 原 05-哲学与方法论 +├── guides/ # 入门与方法（getting-started + playbook） +│ ├── getting-started/ # 原 01-入门指南 +│ └── playbook/ # 原 02-方法论 +└── case-studies/ # 原 03-实战 ``` ## 操作规范 @@ -25,11 +27,10 @@ assets/documents/ ### 禁止 - 删除现有文档（除非明确要求） -- 修改目录编号前缀规则 - - 大规模重命名/移动文件导致链接失效（如必须调整，需同步更新引用） +- 大规模重命名/移动文件导致链接失效（如必须调整，需同步更新引用） ## 命名规范 - 文件名使用中文 - 使用 Markdown 格式 -- 编号前缀保持一致性 +- 目录名使用简短英文（便于跨平台与链接稳定） diff --git a/assets/documents/README.md b/assets/documents/README.md index 9c48c00..9186464 100644 --- a/assets/documents/README.md +++ b/assets/documents/README.md @@ -6,32 +6,32 @@ ``` assets/documents/ -├── 05-哲学与方法论/ # 最高思想纲领，底层逻辑 -├── 00-基础指南/ # 核心理念，胶水编程，方法论 -├── 01-入门指南/ # 从零开始，环境配置 -├── 02-方法论/ # 工具教程，开发经验 -└── 03-实战/ # 项目实战经验 +├── principles/ # 原则与思想（fundamentals + philosophy） +│ ├── fundamentals/ # 原 00-基础指南 +│ └── philosophy/ # 原 05-哲学与方法论 +├── guides/ # 入门与方法（getting-started + playbook） +│ ├── getting-started/ # 原 01-入门指南 +│ └── playbook/ # 原 02-方法论 +└── case-studies/ # 原 03-实战 ``` ## 🚀 快速导航 | 目录 | 说明 | 适合人群 | |:---|:---|:---| -| [05-哲学与方法论](./05-哲学与方法论/) | 思想纲领、认识论工具 | 架构师与深度开发者 | -| [00-基础指南](./00-基础指南/) | 胶水编程、核心理念 | 理解本质 | -| [01-入门指南](./01-入门指南/) | 环境配置、从零开始 | 新手入门 | -| [02-方法论](./02-方法论/) | 工具教程、开发经验 | 提升效率 | -| [03-实战](./03-实战/) | 项目经验、案例复盘 | 动手实践 | +| [principles](./principles/) | 原则与思想（基础 + 哲学） | 架构师与深度开发者 | +| [guides](./guides/) | 入门与方法（上手 + 工具与经验） | 新手入门与效率提升 | +| [case-studies](./case-studies/) | 项目经验、案例复盘 | 动手实践 | ## 📖 推荐学习路径 -1. **思维** → [05-哲学与方法论](./05-哲学与方法论/README.md) -2. **理念** → [胶水编程](./00-基础指南/胶水编程.md) -3. **入门** → [Vibe Coding 哲学原理](./01-入门指南/00-Vibe%20Coding%20哲学原理.md) -3. **配置** → [开发环境搭建](./01-入门指南/02-开发环境搭建.md) -4. **工具** → [tmux 快捷键](./02-方法论/tmux快捷键大全.md) -5. **远程** → [VS Code Remote Tunnel（WSL）](./02-方法论/REMOTE_TUNNEL_GUIDE.md) -5. **实践** → [项目实战经验](./03-实战/) +1. **思维** → [philosophy](./principles/philosophy/README.md) +2. **理念** → [胶水编程](./principles/fundamentals/胶水编程.md) +3. **入门** → [Vibe Coding 哲学原理](./guides/getting-started/00-Vibe%20Coding%20哲学原理.md) +4. **配置** → [开发环境搭建](./guides/getting-started/02-开发环境搭建.md) +5. **工具** → [tmux 快捷键](./guides/playbook/tmux快捷键大全.md) +6. **远程** → [VS Code Remote Tunnel（WSL）](./guides/playbook/REMOTE_TUNNEL_GUIDE.md) +7. **实践** → [项目实战经验](./case-studies/) ## 🔗 相关资源