vibe-coding-cn/documents
tukuaiai 060b3df155 fix(docs): Update documents/README.md to reflect new structure
The README in the documents folder was not updated after the recent refactoring. This commit updates the file to accurately list the new directory structure and file locations.
2025-12-16 21:20:13 +08:00
..
Methodology and Principles refactor(docs): 重命名目录以移除 '&' 符号 2025-12-16 21:12:56 +08:00
Templates and Resources refactor(docs): 重命名目录以移除 '&' 符号 2025-12-16 21:12:56 +08:00
Tutorials and Guides refactor(docs): 重命名目录以移除 '&' 符号 2025-12-16 21:12:56 +08:00
README.md fix(docs): Update documents/README.md to reflect new structure 2025-12-16 21:20:13 +08:00

README.md

📖 文档库 (Documents)

documents/ 目录汇总项目的流程文档、架构说明、开发经验与最佳实践,是理解方法论与协作规则的首选入口。

目录结构

documents/
├── README.md
│
├── Methodology and Principles/
│   ├── A Formalization of Recursive Self-Optimizing Generative Systems.md
│   ├── gluecoding.md
│   ├── vibe-coding-经验收集.md
│   ├── 学习经验.md
│   ├── 开发经验.md
│   ├── 编程之道.md
│   ├── 胶水编程.md
│   └── 系统提示词构建原则.md
│
├── Tutorials and Guides/
│   ├── auggie-mcp配置文档.md
│   ├── LazyVim快捷键大全.md
│   ├── tmux快捷键大全.md
│   ├── 关于手机ssh任意位置链接本地计算机基于frp实现的方法.md
│   └── telegram-dev/
│
└── Templates and Resources/
    ├── 代码组织.md
    ├── 工具集.md
    ├── 编程书籍推荐.md
    └── 通用项目架构模板.md

文档分类

Methodology and Principles

此类别存放关于编程思想、开发哲学和项目核心原则的文档。

  • A Formalization of Recursive Self-Optimizing Generative Systems.md
  • gluecoding.md
  • vibe-coding-经验收集.md
  • 学习经验.md
  • 开发经验.md
  • 编程之道.md
  • 胶水编程.md
  • 系统提示词构建原则.md

Tutorials and Guides

此类别存放具体工具的配置、使用指南和操作教程。

  • auggie-mcp配置文档.md
  • LazyVim快捷键大全.md
  • tmux快捷键大全.md
  • 关于手机ssh任意位置链接本地计算机基于frp实现的方法.md
  • telegram-dev/

Templates and Resources

此类别存放可复用的项目模板、代码结构规范和资源列表。

  • 代码组织.md
  • 工具集.md
  • 编程书籍推荐.md
  • 通用项目架构模板.md

贡献新文档

  1. 将文档放置在最合适的分类目录中。
  2. 如果需要,可以创建新的分类目录。
  3. 更新本 README 文件以反映变更。

相关资源