feat: 全面同步本地项目结构与文档更新

This commit is contained in:
tukuaiai 2025-12-16 21:52:14 +08:00
parent 307c6951ee
commit 4780497867
111 changed files with 178 additions and 718 deletions

View File

@ -1,11 +1,12 @@
# Repository Guidelines
## Project Structure & Module Organization
- 根目录:`README.md` 给出全貌,`Makefile` 封装日常命令,`CONTRIBUTING.md` 说明贡献流程,`LICENSE` 载明协议。保持根目录扁平,避免巨石文件。
- 文档库:`i18n/zh/documents/` 汇总流程、架构与实践(如 `i18n/zh/documents/Templates and Resources/代码组织.md`、`i18n/zh/documents/Templates and Resources/通用项目架构模板.md`、`i18n/zh/documents/Methodology and Principles/开发经验.md`),是理解方法论与协作规则的首选入口。新增流程文档时优先放此处并在 README 链接。
- 提示词资产:`i18n/zh/prompts/` 按角色拆分system / assistant / coding / user`libs/external/prompts-library/` 提供 Excel ↔ Markdown 互转工具与脚本目录,便于批量维护提示词,适合作为“单一真实来源”。
- 代码与集成:`libs/` 预留核心实现骨架,`common/`、`database/`、`external/` 分别对应通用模型、存储适配与外部依赖登记;新增模块需保持分层边界与单一职责,避免跨层调用。
- 备份:`backups/` 内含 `一键备份.sh``快速备份.py`,用于本地快照或同步,请先在隔离目录试跑,确认输出路径与权限。
## Project Structure & Module Organization
- 根目录:`README.md` 给出全貌,`Makefile` 封装日常命令,`CONTRIBUTING.md` 说明贡献流程,`LICENSE` 载明协议。保持根目录扁平,避免巨石文件。
- 多语言 i18n`i18n/<lang>/` 统一三层结构documents / prompts / skills。现有语言中文 `zh`、英文 `en`、希伯来语 `he`,以及高频使用的西语 `es`、印地语 `hi`、阿语 `ar`、葡语 `pt`、俄语 `ru`、法语 `fr`、德语 `de`、日语 `ja`、韩语 `ko`;新增语言遵循同样层级。
- 文档库:`i18n/zh/documents/` 仍是默认中文方法论入口(如 `i18n/zh/documents/Templates and Resources/代码组织.md` 等),新增语言文档按需在对应 `documents/` 下创建并保持同步。
- 提示词资产:`i18n/zh/prompts/` 按角色拆分system / assistant / coding / user`libs/external/prompts-library/` 提供 Excel ↔ Markdown 互转工具与脚本目录,便于批量维护提示词,适合作为“单一真实来源”。
- 代码与集成:`libs/` 预留核心实现骨架,`common/`、`database/`、`external/` 分别对应通用模型、存储适配与外部依赖登记;新增模块需保持分层边界与单一职责,避免跨层调用。
- 备份:`backups/` 内含 `一键备份.sh``快速备份.py`,用于本地快照或同步,请先在隔离目录试跑,确认输出路径与权限。
## Build, Test, and Development Commands
- `make help`:列出所有 Make 目标,是新人快速上手的入口。
@ -143,10 +144,10 @@ When modifying this repository:
## 文件结构 (File Structure)
```
.
├── .gitignore # Git 版本控制忽略文件配置
├── AGENTS.md # 面向 AI Agent 的贡献与行为准则。
```
.
├── .gitignore # Git 版本控制忽略文件配置
├── AGENTS.md # 面向 AI Agent 的贡献与行为准则。
├── CLAUDE.md # 面向 Claude 模型的上下文与指令。
├── CODE_OF_CONDUCT.md # 项目行为准则。
├── CONTRIBUTING.md # 贡献指南。
@ -155,10 +156,13 @@ When modifying this repository:
├── Makefile # 项目自动化脚本 (lint, backup 等)。
├── README.md # 项目主文档,包含项目概览、使用指南等。
├── i18n/zh/documents/ # 存放各类说明文档、经验总结和配置。
│ └── ... # 更多文档内容。
├── libs/ # 核心库代码。
├── i18n/
│ ├── zh/{documents,prompts,skills} # 中文主语料与方法论。
│ ├── en/{documents,prompts,skills} # 英文版本资产。
│ ├── he/{documents,prompts,skills} # 希伯来语(以色列)。
│ ├── es|hi|ar|pt|ru|fr|de|ja|ko/{documents,prompts,skills} # 其他高频语言骨架。
├── libs/ # 核心库代码。
│ ├── common/ # 通用功能和工具库。
│ │ ├── __init__.py # Python 包初始化文件。
│ │ ├── models/ # 数据模型定义。
@ -185,4 +189,4 @@ When modifying this repository:
├── postgresql/ # PostgreSQL 数据库技能。
├── telegram-dev/ # Telegram Bot 开发技能。
└── ... (其他 10+ 个技能)
```
```

View File

@ -1,12 +1,3 @@
# Vibe Coding CN
Welcome to the Vibe Coding CN repository. Please select your language:
- [**English**](./i18n/en/README.md)
- [**简体中文**](./i18n/zh/README.md)
---
<!--
-------------------------------------------------------------------------------
项目头部区域 (HEADER)
@ -165,10 +156,10 @@ Welcome to the Vibe Coding CN repository. Please select your language:
* [**第三方系统提示词学习库**](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/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=1770874220#gid=1770874220): 用于生成提示词的高级提示词。
* [**通用项目架构模板**](./documents/Templates%20and%20Resources/通用项目架构模板.md): 可用于快速搭建标准化的项目目录结构。
* [**元技能Skills 的 Skills**](./skills/claude-skills/SKILL.md): 用于生成 Skills 的元技能。
* [**tmux快捷键大全**](./documents/Tutorials%20and%20Guides/tmux快捷键大全.md): tmux 的快捷键参考文档。
* [**LazyVim快捷键大全**](./documents/Tutorials%20and%20Guides/LazyVim快捷键大全.md): LazyVim 的快捷键参考文档。
* [**通用项目架构模板**](./i18n/zh/documents/Templates%20and%20Resources/通用项目架构模板.md): 可用于快速搭建标准化的项目目录结构。
* [**元技能Skills 的 Skills**](./i18n/zh/skills/claude-skills/SKILL.md): 用于生成 Skills 的元技能。
* [**tmux快捷键大全**](./i18n/zh/documents/Tutorials%20and%20Guides/tmux快捷键大全.md): tmux 的快捷键参考文档。
* [**LazyVim快捷键大全**](./i18n/zh/documents/Tutorials%20and%20Guides/LazyVim快捷键大全.md): LazyVim 的快捷键参考文档。
* [**二哥的Java进阶之路**](https://javabetter.cn/): 包含多种开发工具的详细配置教程。
* [**虚拟卡**](https://www.bybit.com/cards/?ref=YDGAVPN&source=applet_invite): 可用于注册云服务等需要国际支付的场景。
@ -190,23 +181,23 @@ Welcome to the Vibe Coding CN repository. Please select your language:
* [Telegram 交流群](https://t.me/glue_coding)
* [Telegram 频道](https://t.me/tradecat_ai_channel)
* **个人分享**:
* [我的学习经验](./documents/Methodology%20and%20Principles/学习经验.md)
* [编程书籍推荐](./documents/Templates%20and%20Resources/编程书籍推荐.md)
* [我的学习经验](./i18n/zh/documents/Methodology%20and%20Principles/学习经验.md)
* [编程书籍推荐](./i18n/zh/documents/Templates%20and%20Resources/编程书籍推荐.md)
* **核心资源**:
* [**元提示词库**](https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=1770874220#gid=1770874220): 用于生成提示词的高级提示词集合。
* [**元技能 (Meta-Skill)**](./skills/claude-skills/SKILL.md): 用于生成 Skills 的 Skill。
* [**技能库 (Skills)**](./skills): 可直接集成的模块化技能仓库。
* [**元技能 (Meta-Skill)**](./i18n/zh/skills/claude-skills/SKILL.md): 用于生成 Skills 的 Skill。
* [**技能库 (Skills)**](./i18n/zh/skills): 可直接集成的模块化技能仓库。
* [**技能生成器**](https://github.com/yusufkaraaslan/Skill_Seekers): 将任何资料转化为 Agent 可用技能的工具。
* [**在线提示词数据库**](https://docs.google.com/spreadsheets/d/1ngoQOhJqdguwNAilCl1joNwTje7FWWN9WiI2bo5VhpU/edit?gid=2093180351#gid=2093180351&range=A1): 包含数百个适用于各场景的用户及系统提示词的在线表格。
* [**第三方系统提示词仓库**](https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools): 汇集了多种 AI 工具的系统提示词。
* **项目内部文档**:
* [**prompts-library 工具说明**](./libs/external/prompts-library/): 该工具支持在 Excel 和 Markdown 格式之间转换提示词,并包含数百个精选提示词。
* [**coding_prompts 集合**](./prompts/coding_prompts/): 适用于 Vibe Coding 流程的专用提示词。
* [**系统提示词构建原则**](./documents/Methodology%20and%20Principles/系统提示词构建原则.md): 关于如何构建高效、可靠的 AI 系统提示词的综合指南。
* [**开发经验总结**](./documents/Methodology%20and%20Principles/开发经验.md): 包含变量命名、文件结构、编码规范、架构原则等实践经验。
* [**通用项目架构模板**](./documents/Templates%20and%20Resources/通用项目架构模板.md): 提供多种项目类型的标准目录结构与最佳实践。
* [**Augment MCP 配置文档**](./documents/Tutorials%20and%20Guides/auggie-mcp配置文档.md): Augment 上下文引擎的详细配置说明。
* [**system_prompts 集合**](./prompts/system_prompts/): 用于指导 AI 开发的系统提示词,包含多个版本的开发规范与思维框架。
* [**coding_prompts 集合**](./i18n/zh/prompts/coding_prompts/): 适用于 Vibe Coding 流程的专用提示词。
* [**系统提示词构建原则**](./i18n/zh/documents/Methodology%20and%20Principles/系统提示词构建原则.md): 关于如何构建高效、可靠的 AI 系统提示词的综合指南。
* [**开发经验总结**](./i18n/zh/documents/Methodology%20and%20Principles/开发经验.md): 包含变量命名、文件结构、编码规范、架构原则等实践经验。
* [**通用项目架构模板**](./i18n/zh/documents/Templates%20and%20Resources/通用项目架构模板.md): 提供多种项目类型的标准目录结构与最佳实践。
* [**Augment MCP 配置文档**](./i18n/zh/documents/Tutorials%20and%20Guides/auggie-mcp配置文档.md): Augment 上下文引擎的详细配置说明。
* [**system_prompts 集合**](./i18n/zh/prompts/system_prompts/): 用于指导 AI 开发的系统提示词,包含多个版本的开发规范与思维框架。
---
@ -226,7 +217,7 @@ Welcome to the Vibe Coding CN repository. Please select your language:
├── AGENTS.md # AI 代理相关的文档或配置。
├── CLAUDE.md # AI 助手的核心行为准则或配置。
├── documents/ # 存放各类说明文档、经验总结和配置详细说明。
├── i18n/zh/documents/ # 存放各类说明文档、经验总结和配置详细说明。
│ ├── Methodology and Principles/ # 方法论与原则
│ ├── Templates and Resources/ # 模板与资源
│ └── Tutorials and Guides/ # 教程与指南
@ -249,7 +240,7 @@ Welcome to the Vibe Coding CN repository. Please select your language:
│ │ └── ... (其他 prompts-library 内部文件)
│ └── XHS-image-to-PDF-conversion/ # 小红书图片转PDF工具。
├── prompts/ # 集中存放所有类型的 AI 提示词。
├── i18n/zh/prompts/ # 集中存放所有类型的 AI 提示词。
│ ├── assistant_prompts/ # 辅助类提示词。
│ ├── coding_prompts/ # 专门用于编程和代码生成相关的提示词集合。
│ │ └── ... (具体编程提示词文件)
@ -262,7 +253,7 @@ Welcome to the Vibe Coding CN repository. Please select your language:
│ ├── 数据管道.md # 数据管道处理提示词。
│ └── ... (其他用户提示词)
├── skills/ # 集中存放所有类型的 skills 技能。
├── i18n/zh/skills/ # 集中存放所有类型的 skills 技能。
├── claude-skills # 生成 SKILL 的元 SKILL
│ ├── SKILL.md
│ └── ... (其他)
@ -276,20 +267,19 @@ Welcome to the Vibe Coding CN repository. Please select your language:
一句话Vibe Coding = **规划驱动 + 上下文固定 + AI 结对执行**,让「从想法到可维护代码」变成一条可审计的流水线,而不是一团无法迭代的巨石文件。
**你能得到**
- 成体系的提示词工具链:`prompts/system_prompts/` 约束 AI 行为边界,`prompts/coding_prompts/` 提供需求澄清、计划、执行的全链路脚本。
- 成体系的提示词工具链:`i18n/zh/prompts/system_prompts/` 约束 AI 行为边界,`i18n/zh/prompts/coding_prompts/` 提供需求澄清、计划、执行的全链路脚本。
- 闭环交付路径:需求 → 上下文文档 → 实施计划 → 分步实现 → 自测 → 进度记录,全程可复盘、可移交。
## ⚙️ 架构与工作流程
核心资产映射:
```
prompts/
i18n/zh/prompts/
coding_prompts/ # 需求澄清、计划、执行链的核心提示词
system_prompts/ # 约束 AI 行为边界的系统级提示词
assistant_prompts/ # 辅助/配合型提示
user_prompts/ # 可复用的用户侧提示词
prompts-library/ # Excel↔Markdown 提示词转换与索引工具
documents/
i18n/zh/documents/
Templates and Resources/代码组织.md, Templates and Resources/通用项目架构模板.md, Methodology and Principles/开发经验.md, Methodology and Principles/系统提示词构建原则.md 等知识库
backups/
一键备份.sh, 快速备份.py # 本地/远端快照脚本
@ -333,11 +323,11 @@ graph TB
end
subgraph consume_layer[执行与消费层]
artifacts_md --> catalog_coding[prompts/coding_prompts]
artifacts_md --> catalog_system[prompts/system_prompts]
artifacts_md --> catalog_assist[prompts/assistant_prompts]
artifacts_md --> catalog_user[prompts/user_prompts]
artifacts_md --> docs_repo[documents/*]
artifacts_md --> catalog_coding[i18n/zh/prompts/coding_prompts]
artifacts_md --> catalog_system[i18n/zh/prompts/system_prompts]
artifacts_md --> catalog_assist[i18n/zh/prompts/assistant_prompts]
artifacts_md --> catalog_user[i18n/zh/prompts/user_prompts]
artifacts_md --> docs_repo[i18n/zh/documents/*]
artifacts_md --> new_consumer[预留:其他下游渠道]
catalog_coding --> ai_flow[AI 结对编程流程]
ai_flow --> deliverables[项目上下文 / 计划 / 代码产出]

5
i18n/ar/README.md Normal file
View File

@ -0,0 +1,5 @@
# ar 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/ar/prompts/.gitkeep Normal file
View File

0
i18n/ar/skills/.gitkeep Normal file
View File

5
i18n/bn/README.md Normal file
View File

@ -0,0 +1,5 @@
# bn 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/bn/prompts/.gitkeep Normal file
View File

0
i18n/bn/skills/.gitkeep Normal file
View File

5
i18n/de/README.md Normal file
View File

@ -0,0 +1,5 @@
# de 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/de/prompts/.gitkeep Normal file
View File

0
i18n/de/skills/.gitkeep Normal file
View File

View File

@ -1,9 +1,5 @@
# Vibe Coding CN (English)
# en 语言包
Welcome to the English version of the Vibe Coding CN repository.
*This section is under construction. Content is being translated from the [Chinese version](../zh/README.md).*
- [Documents](./documents/)
- [Prompts](./prompts/)
- [Skills](./skills/)
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

View File

@ -1,3 +0,0 @@
# Content Under Construction
This section is currently being translated from the Chinese version. Please check back later.

0
i18n/en/prompts/.gitkeep Normal file
View File

View File

@ -1,3 +0,0 @@
# Content Under Construction
This section is currently being translated from the Chinese version. Please check back later.

0
i18n/en/skills/.gitkeep Normal file
View File

View File

@ -1,3 +0,0 @@
# Content Under Construction
This section is currently being translated from the Chinese version. Please check back later.

5
i18n/es/README.md Normal file
View File

@ -0,0 +1,5 @@
# es 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/es/prompts/.gitkeep Normal file
View File

0
i18n/es/skills/.gitkeep Normal file
View File

5
i18n/fa/README.md Normal file
View File

@ -0,0 +1,5 @@
# fa 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/fa/prompts/.gitkeep Normal file
View File

0
i18n/fa/skills/.gitkeep Normal file
View File

5
i18n/fr/README.md Normal file
View File

@ -0,0 +1,5 @@
# fr 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/fr/prompts/.gitkeep Normal file
View File

0
i18n/fr/skills/.gitkeep Normal file
View File

5
i18n/ha/README.md Normal file
View File

@ -0,0 +1,5 @@
# ha 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/ha/prompts/.gitkeep Normal file
View File

0
i18n/ha/skills/.gitkeep Normal file
View File

5
i18n/he/README.md Normal file
View File

@ -0,0 +1,5 @@
# he 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/he/prompts/.gitkeep Normal file
View File

0
i18n/he/skills/.gitkeep Normal file
View File

5
i18n/hi/README.md Normal file
View File

@ -0,0 +1,5 @@
# hi 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/hi/prompts/.gitkeep Normal file
View File

0
i18n/hi/skills/.gitkeep Normal file
View File

5
i18n/id/README.md Normal file
View File

@ -0,0 +1,5 @@
# id 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/id/prompts/.gitkeep Normal file
View File

0
i18n/id/skills/.gitkeep Normal file
View File

5
i18n/it/README.md Normal file
View File

@ -0,0 +1,5 @@
# it 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/it/prompts/.gitkeep Normal file
View File

0
i18n/it/skills/.gitkeep Normal file
View File

5
i18n/ja/README.md Normal file
View File

@ -0,0 +1,5 @@
# ja 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/ja/prompts/.gitkeep Normal file
View File

0
i18n/ja/skills/.gitkeep Normal file
View File

5
i18n/ko/README.md Normal file
View File

@ -0,0 +1,5 @@
# ko 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/ko/prompts/.gitkeep Normal file
View File

0
i18n/ko/skills/.gitkeep Normal file
View File

5
i18n/ms/README.md Normal file
View File

@ -0,0 +1,5 @@
# ms 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/ms/prompts/.gitkeep Normal file
View File

0
i18n/ms/skills/.gitkeep Normal file
View File

5
i18n/nl/README.md Normal file
View File

@ -0,0 +1,5 @@
# nl 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/nl/prompts/.gitkeep Normal file
View File

0
i18n/nl/skills/.gitkeep Normal file
View File

5
i18n/pl/README.md Normal file
View File

@ -0,0 +1,5 @@
# pl 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/pl/prompts/.gitkeep Normal file
View File

0
i18n/pl/skills/.gitkeep Normal file
View File

5
i18n/pt/README.md Normal file
View File

@ -0,0 +1,5 @@
# pt 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/pt/prompts/.gitkeep Normal file
View File

0
i18n/pt/skills/.gitkeep Normal file
View File

5
i18n/ru/README.md Normal file
View File

@ -0,0 +1,5 @@
# ru 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/ru/prompts/.gitkeep Normal file
View File

0
i18n/ru/skills/.gitkeep Normal file
View File

5
i18n/sw/README.md Normal file
View File

@ -0,0 +1,5 @@
# sw 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/sw/prompts/.gitkeep Normal file
View File

0
i18n/sw/skills/.gitkeep Normal file
View File

5
i18n/ta/README.md Normal file
View File

@ -0,0 +1,5 @@
# ta 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/ta/prompts/.gitkeep Normal file
View File

0
i18n/ta/skills/.gitkeep Normal file
View File

5
i18n/th/README.md Normal file
View File

@ -0,0 +1,5 @@
# th 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/th/prompts/.gitkeep Normal file
View File

0
i18n/th/skills/.gitkeep Normal file
View File

5
i18n/tr/README.md Normal file
View File

@ -0,0 +1,5 @@
# tr 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/tr/prompts/.gitkeep Normal file
View File

0
i18n/tr/skills/.gitkeep Normal file
View File

5
i18n/uk/README.md Normal file
View File

@ -0,0 +1,5 @@
# uk 语言包
- documents/: 该语言的文档与方法论
- prompts/: 该语言的提示词资产
- skills/: 该语言的技能与参考

View File

0
i18n/uk/prompts/.gitkeep Normal file
View File

Some files were not shown because too many files have changed in this diff Show More