|
@@ -1,104 +1,76 @@
|
|
|
# 📖 文档库 (Documents)
|
|
# 📖 文档库 (Documents)
|
|
|
|
|
|
|
|
-`documents/` 目录汇总项目的流程文档、架构说明、开发经验与最佳实践,是理解方法论与协作规则的首选入口。当前包含 **14 个**文档。
|
|
|
|
|
|
|
+`documents/` 目录汇总项目的流程文档、架构说明、开发经验与最佳实践,是理解方法论与协作规则的首选入口。
|
|
|
|
|
|
|
|
## 目录结构
|
|
## 目录结构
|
|
|
|
|
|
|
|
```
|
|
```
|
|
|
documents/
|
|
documents/
|
|
|
-├── README.md # 本文件
|
|
|
|
|
|
|
+├── README.md
|
|
|
│
|
|
│
|
|
|
-├── # === 方法论与理念 ===
|
|
|
|
|
-├── 编程之道.md # 编程哲学与核心理念(5.4KB)
|
|
|
|
|
-├── 胶水编程.md # 胶水编程方法论(4KB)
|
|
|
|
|
-├── gluecoding.md # Glue Coding 英文版(5.2KB)
|
|
|
|
|
-├── 小登论道.md # 学习经验分享
|
|
|
|
|
|
|
+├── Methodology and Principles/
|
|
|
|
|
+│ ├── A Formalization of Recursive Self-Optimizing Generative Systems.md
|
|
|
|
|
+│ ├── gluecoding.md
|
|
|
|
|
+│ ├── vibe-coding-经验收集.md
|
|
|
|
|
+│ ├── 学习经验.md
|
|
|
|
|
+│ ├── 开发经验.md
|
|
|
|
|
+│ ├── 编程之道.md
|
|
|
|
|
+│ ├── 胶水编程.md
|
|
|
|
|
+│ └── 系统提示词构建原则.md
|
|
|
│
|
|
│
|
|
|
-├── # === 开发实践 ===
|
|
|
|
|
-├── 开发经验.md # 变量命名、编码规范、架构原则(5KB)
|
|
|
|
|
-├── 代码组织.md # 代码结构与组织方式(1.7KB)
|
|
|
|
|
-├── vibe-coding-经验收集.md # AI 开发最佳实践(2.3KB)
|
|
|
|
|
-├── 通用项目架构模板.md # 项目目录结构模板(13KB)⭐推荐
|
|
|
|
|
|
|
+├── Tutorials and Guides/
|
|
|
|
|
+│ ├── auggie-mcp配置文档.md
|
|
|
|
|
+│ ├── LazyVim快捷键大全.md
|
|
|
|
|
+│ ├── tmux快捷键大全.md
|
|
|
|
|
+│ ├── 关于手机ssh任意位置链接本地计算机,基于frp实现的方法.md
|
|
|
|
|
+│ └── telegram-dev/
|
|
|
│
|
|
│
|
|
|
-├── # === 工具与配置 ===
|
|
|
|
|
-├── 工具集.md # 开发工具推荐
|
|
|
|
|
-├── auggie-mcp配置文档.md # Augment 上下文引擎配置(2.7KB)
|
|
|
|
|
-├── tmux快捷键大全.md # tmux 终端复用快捷键(1.1KB)
|
|
|
|
|
-├── LazyVim快捷键大全.md # LazyVim 快捷键大全(8.0KB)
|
|
|
|
|
-├── 关于手机ssh任意位置链接本地计算机,基于frp实现的方法.md # FRP 内网穿透(10.6KB)
|
|
|
|
|
-│
|
|
|
|
|
-├── # === 提示词与 AI ===
|
|
|
|
|
-├── 系统提示词构建原则.md # 系统提示词设计指南(5.6KB)
|
|
|
|
|
-│
|
|
|
|
|
-└── # === 学习资源 ===
|
|
|
|
|
- └── 编程书籍推荐.md # 编程书籍推荐列表(6KB)
|
|
|
|
|
|
|
+└── Templates and Resources/
|
|
|
|
|
+ ├── 代码组织.md
|
|
|
|
|
+ ├── 工具集.md
|
|
|
|
|
+ ├── 编程书籍推荐.md
|
|
|
|
|
+ └── 通用项目架构模板.md
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
## 文档分类
|
|
## 文档分类
|
|
|
|
|
|
|
|
-### 🧘 方法论与理念
|
|
|
|
|
-
|
|
|
|
|
-| 文档 | 大小 | 说明 |
|
|
|
|
|
-|------|------|------|
|
|
|
|
|
-| `编程之道.md` | 5.4KB | 编程哲学、核心理念、思维方式 |
|
|
|
|
|
-| `胶水编程.md` | 4KB | 胶水编程方法论(中文) |
|
|
|
|
|
-| `gluecoding.md` | 5.2KB | Glue Coding 方法论(英文) |
|
|
|
|
|
-| `小登论道.md` | 0.2KB | 个人学习经验分享 |
|
|
|
|
|
-
|
|
|
|
|
-### 💻 开发实践
|
|
|
|
|
-
|
|
|
|
|
-| 文档 | 大小 | 说明 |
|
|
|
|
|
-|------|------|------|
|
|
|
|
|
-| `通用项目架构模板.md` | 13KB | ⭐ 多种项目类型的标准目录结构、设计原则、技术选型 |
|
|
|
|
|
-| `开发经验.md` | 5KB | 变量命名、文件结构、编码规范、微服务、Redis、消息队列 |
|
|
|
|
|
-| `代码组织.md` | 1.7KB | 代码结构与组织方式 |
|
|
|
|
|
-| `vibe-coding-经验收集.md` | 2.3KB | AI 开发最佳实践与系统提示词优化技巧 |
|
|
|
|
|
-
|
|
|
|
|
-### 🔧 工具与配置
|
|
|
|
|
-
|
|
|
|
|
-| 文档 | 大小 | 说明 |
|
|
|
|
|
-|------|------|------|
|
|
|
|
|
-| `auggie-mcp配置文档.md` | 2.7KB | Augment 上下文引擎 MCP 配置 |
|
|
|
|
|
-| `tmux快捷键大全.md` | 1.1KB | tmux 终端复用快捷键速查 |
|
|
|
|
|
-| `LazyVim快捷键大全.md` | 8.0KB | LazyVim 快捷键大全 |
|
|
|
|
|
-| `关于手机ssh...frp实现的方法.md` | 10.6KB | FRP 内网穿透,手机 SSH 连接本地电脑 |
|
|
|
|
|
-| `工具集.md` | 0.5KB | 开发工具推荐列表 |
|
|
|
|
|
|
|
+### Methodology and Principles
|
|
|
|
|
|
|
|
-### 🤖 提示词与 AI
|
|
|
|
|
|
|
+此类别存放关于编程思想、开发哲学和项目核心原则的文档。
|
|
|
|
|
|
|
|
-| 文档 | 大小 | 说明 |
|
|
|
|
|
-|------|------|------|
|
|
|
|
|
-| `系统提示词构建原则.md` | 5.6KB | 系统提示词设计指南:沟通互动、任务执行、编码规范、安全防护 |
|
|
|
|
|
|
|
+* `A Formalization of Recursive Self-Optimizing Generative Systems.md`
|
|
|
|
|
+* `gluecoding.md`
|
|
|
|
|
+* `vibe-coding-经验收集.md`
|
|
|
|
|
+* `学习经验.md`
|
|
|
|
|
+* `开发经验.md`
|
|
|
|
|
+* `编程之道.md`
|
|
|
|
|
+* `胶水编程.md`
|
|
|
|
|
+* `系统提示词构建原则.md`
|
|
|
|
|
|
|
|
-### 📚 学习资源
|
|
|
|
|
|
|
+### Tutorials and Guides
|
|
|
|
|
|
|
|
-| 文档 | 大小 | 说明 |
|
|
|
|
|
-|------|------|------|
|
|
|
|
|
-| `编程书籍推荐.md` | 6KB | 编程书籍推荐列表与阅读建议 |
|
|
|
|
|
|
|
+此类别存放具体工具的配置、使用指南和操作教程。
|
|
|
|
|
|
|
|
-## 推荐阅读顺序
|
|
|
|
|
|
|
+* `auggie-mcp配置文档.md`
|
|
|
|
|
+* `LazyVim快捷键大全.md`
|
|
|
|
|
+* `tmux快捷键大全.md`
|
|
|
|
|
+* `关于手机ssh任意位置链接本地计算机,基于frp实现的方法.md`
|
|
|
|
|
+* `telegram-dev/`
|
|
|
|
|
|
|
|
-**新手入门**:
|
|
|
|
|
-1. `编程之道.md` - 理解编程哲学
|
|
|
|
|
-2. `通用项目架构模板.md` - 学习项目结构
|
|
|
|
|
-3. `开发经验.md` - 掌握编码规范
|
|
|
|
|
|
|
+### Templates and Resources
|
|
|
|
|
|
|
|
-**Vibe Coding 实践**:
|
|
|
|
|
-1. `胶水编程.md` / `gluecoding.md` - 理解方法论
|
|
|
|
|
-2. `vibe-coding-经验收集.md` - AI 开发技巧
|
|
|
|
|
-3. `系统提示词构建原则.md` - 提示词设计
|
|
|
|
|
|
|
+此类别存放可复用的项目模板、代码结构规范和资源列表。
|
|
|
|
|
|
|
|
-**工具配置**:
|
|
|
|
|
-1. `auggie-mcp配置文档.md` - Augment 引擎
|
|
|
|
|
-2. `tmux快捷键大全.md` - 终端复用
|
|
|
|
|
-3. `关于手机ssh...frp实现的方法.md` - 远程连接
|
|
|
|
|
|
|
+* `代码组织.md`
|
|
|
|
|
+* `工具集.md`
|
|
|
|
|
+* `编程书籍推荐.md`
|
|
|
|
|
+* `通用项目架构模板.md`
|
|
|
|
|
|
|
|
## 贡献新文档
|
|
## 贡献新文档
|
|
|
|
|
|
|
|
-1. 使用清晰的中文命名
|
|
|
|
|
-2. 在文件开头说明文档用途
|
|
|
|
|
-3. 更新本 README 的文档列表
|
|
|
|
|
-4. 如有关联,在主 README 中添加链接
|
|
|
|
|
|
|
+1. 将文档放置在最合适的分类目录中。
|
|
|
|
|
+2. 如果需要,可以创建新的分类目录。
|
|
|
|
|
+3. 更新本 README 文件以反映变更。
|
|
|
|
|
|
|
|
## 相关资源
|
|
## 相关资源
|
|
|
|
|
|