| name | create_content |
| description | 根据笔记主题(如 Python、Java、数据结构等)在 main.typ 中生成注释形式的三层目录结构(Part-Chapter-Section) |
生成目录命令
任务说明
当用户要求为某个技术栈或主题生成笔记目录时,在 main.typ 文件中生成注释形式的完整目录结构。
执行步骤
1. 分析主题特点
- 确定技术领域(编程语言、框架、算法、系统等)
- 识别该领域的核心知识点
- 考虑学习路径:基础 → 进阶 → 高级 → 底层/实战
2. 设计 Part 层级(一级)
Part 划分原则:
- 每个 Part 代表一个大的知识模块
- 通常 4-7 个 Part
- Part 之间逻辑递进
常见 Part 模式:
-
编程语言类:
- Part 1:核心基础(语法 + OOP)
- Part 2:高级特性(函数式、元编程等)
- Part 3:标准库与常用工具
- Part 4:工程化与最佳实践
- Part 5:底层原理与性能优化
- Part 6:生态与框架(可选)
-
框架类:
- Part 1:入门与核心概念
- Part 2:核心功能模块
- Part 3:高级特性
- Part 4:工程化与部署
- Part 5:底层原理
-
算法类:
- Part 1:基础数据结构
- Part 2:基础算法
- Part 3:高级数据结构
- Part 4:高级算法
- Part 5:算法设计与分析
3. 设计 Chapter 层级(二级)
Chapter 划分原则:
- 每个 Chapter 是一个完整的知识单元
- 每个 Part 包含 4-8 个 Chapter
- Chapter 标题简洁明了
标记系统:
4. 设计 Section 层级(三级)
Section 划分原则:
- Section 是 Chapter 内的主要知识点
- 每个 Chapter 包含 3-7 个 Section
- Section 标题具体、可操作
格式要求:
- Section 内容紧跟在 Chapter 注释后面
- 使用缩进表示层级关系
- 多个 Section 用换行分隔
5. 生成目录草稿
输出格式:
// ─────────────────────────────────────────────────────────────────────
// Part X:Part 标题
// ─────────────────────────────────────────────────────────────────────
// Chapter 1:Chapter 标题 ✅/🔶/⚪
// 1.1 标题
// 1.2 标题
// 1.3 标题
// Chapter 2:Chapter 标题 ✅/🔶/⚪
// 2.1 标题
// 2.2 标题
注意事项:
- Part 之间用分隔线
// ---... 隔开
- Chapter 之间空一行
- Section 不单独占行,紧跟 Chapter
- 使用 Typst 注释格式
//,不要用 %
6. 添加设计思路注释
在目录草稿的最后,添加一段设计思路注释,简要说明目录的整体设计考量:
- 应用场景:该技术的主要使用领域(如后台开发、数据科学、系统编程等)
- 重点倾斜:将篇幅和深度向哪些核心模块倾斜,为什么
- 面试/实战导向:是否偏重面试高频点或工程实战
- 省略考量:有意不包含哪些内容及原因
格式:
// ─────────────────────────────────────────────────────────────────────
// 设计思路
// ─────────────────────────────────────────────────────────────────────
// 1. 应用场景:xxx
// 2. 重点倾斜:xxx
// 3. 面试/实战:xxx
// 4. 省略考量:xxx
7. 插入到 main.typ
- 找到
main.typ 中的目录区域(通常在最下面)
- 将生成的目录草稿(含设计思路注释)作为注释插入
- 保持原有结构不变
示例
输入
用户请求:"为 Python 教程生成目录"
输出
// ─────────────────────────────────────────────────────────────────────
// Part 1:Python 核心基础(语法 + 编程范式)
// ─────────────────────────────────────────────────────────────────────
// Chapter 1:Python 入门与环境搭建 ✅
// 1.1 语言概述:Python 设计理念、解释型 vs 编译型、动态类型系统
// 1.2 开发环境搭建:Python 安装、虚拟环境(venv/conda)、IDE 配置
// 1.3 运行流程:源码→字节码→解释执行、.pyc 文件作用
// 1.4 第一个程序:Hello World、交互式解释器、脚本模式
// Chapter 2:基础语法 ✅
// 2.1 标识符、注释、编码规范(PEP 8)
// 2.2 变量与数据类型:动态类型、基本类型、类型注解
// 2.3 运算符与表达式:算术、比较、逻辑、身份、成员运算符
// 2.4 流程控制:if-elif-else、for/while 循环、break/continue/pass
// 2.5 输入输出:input()、print() 格式化、f-string
// ─────────────────────────────────────────────────────────────────────
// Part 2:Python 高级特性与函数式编程
// ─────────────────────────────────────────────────────────────────────
// Chapter 1:迭代器与生成器 🔶
// 1.1 迭代协议:__iter__/__next__、可迭代对象
// 1.2 生成器函数:yield、惰性求值、无限序列
// 1.3 生成器表达式:与列表推导式的区别
// 1.4 itertools 模块:高效迭代工具
// Chapter 2:装饰器 🔶
// 2.1 闭包与作用域:嵌套函数、自由变量
// 2.2 装饰器基础:@syntax、函数装饰器
// 2.3 带参数的装饰器、类装饰器
// 2.4 functools 模块:wraps、lru_cache、partial
// 2.5 装饰器实战:日志、缓存、权限检查
// ─────────────────────────────────────────────────────────────────────
// 设计思路
// ─────────────────────────────────────────────────────────────────────
// 1. 应用场景:Python 主要用于后台开发、脚本自动化、数据科学/AI
// 2. 重点倾斜:数据模型和装饰器是 Python 面试高频点且体现设计深度,篇幅较重
// 3. 面试/实战:函数式编程和并发模型侧重工程实践,包含 asyncio 实战案例
// 4. 省略考量:GUI(tkinter)和移动端(Kivy)非主流场景,省略;Web 框架移至独立笔记
关键原则
-
突出领域特色:不同技术栈的目录应体现其独特性
- Python:动态类型、装饰器、GIL、asyncio
- Java:JVM、泛型、并发、Spring 生态
- 算法:数据结构、算法思想、复杂度分析
-
逻辑递进:从基础到高级,循序渐进
-
粒度适中:
- Part:大模块(4-7个)
- Chapter:知识单元(4-8个/Part)
- Section:具体知识点(3-7个/Chapter)
-
标记清晰:
- ✅ 已完成的内容
- 🔶 重点/进行中的内容
- ⚪ 选学/待补充的内容
-
格式规范:
- 使用
// 注释,不用 %
- Part 之间有分隔线
- Chapter 之间有空行
- Section 紧跟 Chapter