mcpField
O
obsidian-study-vault-builder

obsidian-study-vault-builder

github.com/belumume生产力4641 次安装6 周前更新
代码仓库

关于 obsidian-study-vault-builder

Obsidian study vault builder 是用于构建结构化学术学习库的技能，采用分阶段审核，并为大型项目提供错误预防和质量检查。

主要功能

  1. 01按章节分阶段生成与审核
  2. 02三级上下文结构
  3. 03兼容移动端的 Obsidian 格式
  4. 04识别八类常见错误
  5. 05系统化学习库质量检查

适用场景

  1. 01制作考试复习材料
  2. 02整理课程知识
  3. 03组织技术文档
  4. 04检查大型学习库

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/belumume/claude-skills --skill obsidian-study-vault-builder

安装后在 Claude Code 中输入/obsidian-study-vault-builder确认已加载。

附带文件README.mdREFERENCE.md

详细介绍

Obsidian 学习知识库构建器

在 Obsidian 中构建可直接用于备考的学习知识库的全面模式

构建结构清晰、兼容移动设备的学术学习知识库，并采用从真实项目中提炼出的系统化错误预防、质量保证和效率模式。

⚠️ 重要：请参阅 REFERENCE.md，了解从 828KB/37 个文件的知识库项目中总结出的完整实战模式。

何时使用此技能

在 Obsidian 中构建学术学习资料时调用：

  • 期末考试备考（任何学科）
  • 课程知识整理（计算机科学、医学、商科、法律等）
  • 自学资料结构化
  • 技术文档知识库
  • 大规模学习项目（10+ 个文件、200KB+）

适用于所有学科：

  • 计算机科学（算法、数据结构、系统）
  • 医学（解剖学、药理学、病理学）
  • 商科（金融、营销、运营）
  • STEM（物理、化学、工程）
  • 人文学科（历史、文学、哲学）

核心方法论

基于检查点的工作流（关键）

切勿一次性生成所有章节。 应采用渐进式验证：

  1. 生成第 1 章 → 停止
  2. 用户审核 → 批准格式、结构和质量
  3. 第 2 至 N 章 → 按已验证的模式继续
  4. 最终 QA → 系统化验证

这为何重要：

  • 在格式问题扩散到 30+ 个文件前及时发现
  • 尽早验证方案是否符合用户需求
  • 在调整成本较低时（第 1 章）而非较高时（第 8 章）调整方向
  • 避免耗费 5 小时以上返工

时间分配： 第 1 章（约 30 分钟）→ 审核（约 15 分钟）→ 其余章节（约 90 分钟）→ QA（约 30 分钟）= 2.5 小时，而非手动操作的 80 小时

记忆文件层级

三级上下文结构（详情请参阅 REFERENCE.md）：

  • 第 1 级： 根知识库（CLAUDE.md）
  • 第 2 级： 学科文件夹（School/CLAUDE.md）
  • 第 3 级： 课程项目（School/algorithms/CLAUDE.md）

Obsidian 通用功能（移动优先）

✅ 仅使用： Mermaid 图表、LaTeX 数学公式、标准标注、内部链接、表格、代码块
❌ 切勿使用： Dataview 查询、自定义标注、插件

完整模式请参阅 REFERENCE.md。

错误模式识别（8 种模式）

模式 1：Mermaid 中的 Unicode 字符损坏
  • 症状： 图表无法渲染
  • 诊断： grep -r "≤\|≥\|∞\|∈\|≠\|→" *.md
  • 修复： 替换为 ASCII 字符（<=、>=、infinity、in、!=、->）
模式 2：表格损坏（LaTeX 竖线）
  • 诊断： grep -r "| \$.*|.*\$" *.md
  • 修复： 转义竖线：| → \|
模式 3：缺少可折叠解答
  • 诊断： grep -A 5 "## Problem" practice-problems.md | grep -v "\[!example\]-"
  • 修复： 使用 > [!example]- Solution
模式 4-8：请参阅 REFERENCE.md
  • 导航不一致
  • 缺少学习目标
  • 目录不一致
  • 核心概念为空
  • 交叉引用失效

完整的系统化修复方法请参阅 REFERENCE.md。

内容质量模式

强调理解运用（而非死记硬背）

优质问题：

  • “针对 [情境] 设计 [系统]。当前存在 [问题]。描述实现 [目标] 的解决方案。分析权衡并说明理由。”

适用于不同学科：

  • 计算机科学：算法设计场景
  • 医学：基于病例的诊断
  • 商科：战略分析
  • 物理：实验设计
全面覆盖

源材料中的每个主题都必须包含在内。验证方法：将源材料大纲与知识库目录交叉核对。

交叉引用模式

使用 [[links]] 在各处链接相关概念。

完整示例请参阅 REFERENCE.md。

标准知识库结构

course-name/
├── 00-overview/          # Course map, schedule, strategy
├── 01-chapter-name/      # Core concepts, quick-ref, practice
├── cross-chapter/        # Comparisons, patterns, catalog
└── mock-exams/           # Practice tests + solutions

质量保证（摘要）

标记完成前，请确认：

  • 结构一致性（导航、目标、目录）
  • 内容完整性（涵盖所有主题）
  • 格式正确性（Mermaid 中无 Unicode 字符，LaTeX 竖线已转义）
  • 移动端兼容性（不使用插件）
  • 评估一致性（练习题符合考试风格）

完整的 50 多项检查清单请参阅 REFERENCE.md。

常见反模式

  1. “以后再修” → 立即修复
  2. 生成时不设置检查点 → 第 1 章 → 审阅 → 继续
  3. 忽略移动端用户 → 仅使用通用功能
  4. 练习停留在表面 → 基于情境，并要求推理

成功指标

典型项目：

  • 文件：30-40 个
  • 大小：600-900KB
  • 覆盖范围：源主题的 100%
  • 渲染错误：0
  • 节省时间：80 多小时
  • 练习题：80-100 道
  • 模拟考试：2-3 套

集成模式

用于大型分析的任务 Agent

对于 100 多页的材料，请使用 Task 工具，并将 subagent_type 设为 Explore。

Git 工作流
git commit -m "Initial vault structure"
git commit -m "Complete Chapter 1 (checkpoint)"
git commit -m "Complete: Study vault (37 files, 828KB)"

CLI 集成

Obsidian CLI（v1.12+）可在特定操作中辅助 Write 工具。需要 Obsidian 应用处于运行状态。

何时使用 CLI，何时使用 Write 工具
操作工具原因
批量创建新文件Write 工具速度更快，无 shell 开销，无需转义
设置/读取 frontmatterCLI property:set/property:read原生 YAML 处理
在现有文件中追加内容CLI append/prepend感知 Obsidian 状态，可即时更新索引
构建后 QACLI search、unresolved、orphans使用 Obsidian 的实时索引
检查知识库状态CLI files total、vault、sync:status直接访问 Obsidian 元数据
构建后验证

生成知识库后运行，以发现问题：

obsidian.com files folder=<course> total        # Verify file count matches expected
obsidian.com tags counts                        # Verify tags are populated
obsidian.com unresolved                         # Find broken [[wiki-links]]
obsidian.com orphans                            # Find files with no incoming links
obsidian.com deadends                           # Find files with no outgoing links
obsidian.com search query="TODO"                # Catch unfinished placeholders
Frontmatter 操作

修改属性时，请使用 CLI，而不要手动编辑 YAML：

obsidian.com property:set name=tags value="[exam-prep,chapter-1]" type=list path=<file>
obsidian.com property:set name=status value=draft path=<file>
obsidian.com property:read name=tags path=<file>
增量更新

向现有知识库文件添加内容时，无需完整重写：

obsidian.com append path=<file> content="## New Section\n..."
obsidian.com daily:append content="- [ ] Review chapter 3"
同步状态检查

在大型操作前后检查同步状态：

obsidian.com sync:status    # Verify sync is not paused before starting vault build

其他资源

REFERENCE.md 包含：

  • Obsidian 通用功能的完整文档
  • 详细的 Mermaid 图表模式（流程图、思维导图、图、递归树）
  • 带表格转义的详细 LaTeX 符号模式
  • 可折叠的完整解决方案模板
  • 带示例的完整 50 多项质量保证检查清单
  • 学科专属适配示例（计算机科学、医学、商业、人文）
  • 完整的分步工作流示例
  • 错误模式识别（全部 8 种模式及示例）
  • 系统化修复方法（5 步流程）
  • 有效的沟通模式
  • 应避免的反模式
  • 时间投入明细

已在以下项目中经过实战验证：

  • 37 个文件的学术知识库
  • 828KB 的全面覆盖内容
  • 多个学科（计算机科学、工程、商业）
  • 实现零渲染错误
  • 每个项目节省约 80 小时的手动工作

现在即可通过系统化质量保证，为任何学科构建可用于备考的学习知识库。

评论

支持 Markdown