| name | new-module |
| description | 为项目创建新的学习模块。当用户要求添加新的编程语言、框架、工具或技术主题时使用。例如"添加 Rust 模块"、"新建 Docker 学习路径"。 |
| argument-hint | <模块名称> [语言/语言扩展名] |
| disable-model-invocation | true |
| allowed-tools | Read, Write, Bash, Glob, Grep |
创建新学习模块
为 full-stack-roadmap 项目创建一个新的学习模块。
参数
$ARGUMENTS — 模块名称及可选的语言/扩展名(如 Rust .rs、Docker、TypeScript .ts)
项目约定
源码目录结构
每个编程语言模块包含 8 个递进式子目录:
<ModuleName>/ # 大驼峰或原始大小写(如 Go, Python, Rust)
├── 01-basics/ # 基础语法
├── 02-functions/ # 函数
├── 03-structs/ # 结构体/类/核心概念
├── 04-concurrency/ # 并发
├── 05-packages/ # 包管理/模块
├── 06-testing/ # 测试
├── 07-stdlib/ # 标准库
└── 08-projects/ # 项目实战
非编程语言模块(如中间件、架构、工具)使用扁平结构:
<ModuleName>/
├── 01_topic_a.md
├── 02_topic_b.md
└── ...
文件命名
- 代码文件:
XX_name.go(数字前缀 + 下划线 + snake_case)
- 目录名:
XX-name(数字前缀 + 连字符 + kebab-case)
代码风格
- 所有注释使用中文
- 每个文件以大分隔符开头标记主题:
// ============================================================
// 主题名称
// ============================================================
- 小节使用小分隔符:
// ----------------------------------------------------------
// 小节标题
// ----------------------------------------------------------
- 注释详细、有教学意义,面向学习者
文档目录
对应的 docs 目录在 docs/<模块名小写>/,需要创建 index.md 作为入口。
执行步骤
- 确认模块信息:从
$ARGUMENTS 解析模块名称和语言类型
- 检查是否已存在:确认不会覆盖现有模块
- 创建源码目录结构:根据模块类型创建 8 个子目录(编程语言)或扁平目录(其他)
- 创建示例文件:在
01-basics/ 中创建第一个示例文件,包含:
- 标准分隔符风格的中文注释
- 基础语法演示(变量、类型、输出)
- 可直接运行的完整代码
- 创建 docs 入口:在
docs/<模块名小写>/index.md 创建模块首页
- 提示后续操作:
- 运行
npm run convert 生成文档
- 更新
docs/.vitepress/config.ts 的导航和侧边栏
- 继续使用
/new-lesson 添加更多课程
docs/index.md 模板
# <模块名称> 学习路径
## 简介
<一段简要介绍>
## 学习目录
### 基础篇
- 待添加
### 进阶篇
- 待添加
### 实战篇
- 待添加