feat: 更新中文文档并添加 l10n 工具

This commit is contained in:
tukuaiai
2025-12-16 22:05:00 +08:00
parent 5c74e3e781
commit 8971d3653c
7 changed files with 161 additions and 34 deletions
+2 -2
View File
@@ -1,11 +1,11 @@
# 📖 文档库 (Documents)
`documents/` 目录汇总项目的流程文档、架构说明、开发经验与最佳实践,是理解方法论与协作规则的首选入口。
`i18n/zh/documents/` 目录汇总项目的流程文档、架构说明、开发经验与最佳实践,是理解方法论与协作规则的首选入口。
## 目录结构
```
documents/
i18n/zh/documents/
├── README.md
├── Methodology and Principles/
+6 -6
View File
@@ -1,6 +1,6 @@
# 💡 AI 提示词库 (Prompts)
`prompts/` 存放本仓库的提示词资产:用 **系统提示词** 约束 AI 的边界与品味,用 **任务提示词** 驱动「需求澄清 → 计划 → 执行 → 复盘」的开发流水线。
`i18n/zh/prompts/` 存放本仓库的提示词资产:用 **系统提示词** 约束 AI 的边界与品味,用 **任务提示词** 驱动「需求澄清 → 计划 → 执行 → 复盘」的开发流水线。
## 推荐使用路径(从 0 到可控)
@@ -11,7 +11,7 @@
## 目录结构(以仓库真实目录为准)
```
prompts/
i18n/zh/prompts/
├── README.md
├── coding_prompts/ # 编程/研发提示词(当前 41 个 .md)
│ ├── index.md # 自动生成的索引与版本矩阵(请勿手改)
@@ -37,7 +37,7 @@ prompts/
系统提示词用于定义 **工作模式、代码品味、输出格式、安全边界**。目录采用版本化结构:
- 路径约定:`prompts/system_prompts/CLAUDE.md/<版本号>/CLAUDE.md`
- 路径约定:`i18n/zh/prompts/system_prompts/CLAUDE.md/<版本号>/CLAUDE.md`
- 推荐版本:
- `v8`:综合版,适合通用 Vibe Coding
- `v10`:偏 Augment/上下文引擎的规范化约束
@@ -66,15 +66,15 @@ prompts/
```bash
# 查看一个任务提示词
sed -n '1,160p' prompts/coding_prompts/标准化流程.md
sed -n '1,160p' i18n/zh/prompts/coding_prompts/标准化流程.md
# 选定系统提示词版本(建议先备份你当前的 CLAUDE.md)
cp prompts/system_prompts/CLAUDE.md/10/CLAUDE.md ./CLAUDE.md
cp i18n/zh/prompts/system_prompts/CLAUDE.md/10/CLAUDE.md ./CLAUDE.md
```
## 维护与批量管理(可选)
如果你需要 Excel ↔ Markdown 的批量维护能力,仓库内置了第三方工具:`libs/external/prompts-library/`。建议把它视为“提示词资产的生产工具”,而把 `prompts/` 视为“日常开发的精选集”。
如果你需要 Excel ↔ Markdown 的批量维护能力,仓库内置了第三方工具:`libs/external/prompts-library/`。建议把它视为“提示词资产的生产工具”,而把 `i18n/zh/prompts/` 视为“日常开发的精选集”。
## 相关资源
+13 -13
View File
@@ -1,11 +1,11 @@
# 🎯 AI Skills 技能库
`skills/` 目录存放 AI 技能(Skills),这些是比提示词更高级的能力封装,可以让 AI 在特定领域表现出专家级水平。当前包含 **14 个**专业技能。
`i18n/zh/skills/` 目录存放 AI 技能(Skills),这些是比提示词更高级的能力封装,可以让 AI 在特定领域表现出专家级水平。当前包含 **14 个**专业技能。
## 目录结构
```
skills/
i18n/zh/skills/
├── README.md # 本文件
├── # === 元技能(核心) ===
@@ -118,23 +118,23 @@ skill-name/
```bash
# 查看元技能
cat skills/claude-skills/SKILL.md
cat i18n/zh/skills/claude-skills/SKILL.md
# 查看 PostgreSQL 技能(最详细)
cat skills/postgresql/SKILL.md
cat i18n/zh/skills/postgresql/SKILL.md
# 查看 Telegram Bot 开发技能
cat skills/telegram-dev/SKILL.md
cat i18n/zh/skills/telegram-dev/SKILL.md
```
### 2. 复制到项目中使用
```bash
# 复制整个技能目录
cp -r skills/postgresql/ ./my-project/
cp -r i18n/zh/skills/postgresql/ ./my-project/
# 或只复制主文件到 CLAUDE.md
cp skills/postgresql/SKILL.md ./CLAUDE.md
cp i18n/zh/skills/postgresql/SKILL.md ./CLAUDE.md
```
### 3. 结合 Claude Code 使用
@@ -145,8 +145,8 @@ cp skills/postgresql/SKILL.md ./CLAUDE.md
# 项目规则
请参考以下技能文件:
@skills/postgresql/SKILL.md
@skills/telegram-dev/SKILL.md
@i18n/zh/skills/postgresql/SKILL.md
@i18n/zh/skills/telegram-dev/SKILL.md
```
## 创建自定义 Skill
@@ -154,12 +154,12 @@ cp skills/postgresql/SKILL.md ./CLAUDE.md
### 方法一:使用元技能生成(推荐)
1. 准备领域资料(文档、代码、规范)
2. 将资料和 `skills/claude-skills/SKILL.md` 一起提供给 AI
2. 将资料和 `i18n/zh/skills/claude-skills/SKILL.md` 一起提供给 AI
3. AI 会生成针对该领域的专用 Skill
```bash
# 示例:让 AI 读取元技能后生成新技能
cat skills/claude-skills/SKILL.md
cat i18n/zh/skills/claude-skills/SKILL.md
# 然后告诉 AI:请根据这个元技能,为 [你的领域] 生成一个新的 SKILL.md
```
@@ -167,10 +167,10 @@ cat skills/claude-skills/SKILL.md
```bash
# 创建技能目录
mkdir -p skills/my-skill/{assets,scripts,references}
mkdir -p i18n/zh/skills/my-skill/{assets,scripts,references}
# 创建主文件
cat > skills/my-skill/SKILL.md << 'EOF'
cat > i18n/zh/skills/my-skill/SKILL.md << 'EOF'
# My Skill
## 概述