mcpField
O
obsidian-notes-creator

obsidian-notes-creator

github.com/szeyu生产力30624 次安装2 天前更新
代码仓库

关于 obsidian-notes-creator

面向 Obsidian 用户的笔记创建与改进技能,帮助按读者背景组织解释、示例和视觉材料。也支持审查笔记并报告具体缺口,强调内容准确、易读及诚实验证。

主要功能

  1. 01创建、改进或审查笔记
  2. 02按读者背景调整讲解
  3. 03补全推导与示例
  4. 04选择合适的视觉呈现
  5. 05检查链接、计算与图形
  6. 06报告覆盖范围和未解决问题

适用场景

  1. 01为新主题编写学习笔记
  2. 02深化已有笔记并保留原结构
  3. 03检查文件夹内笔记的缺漏
  4. 04验证笔记中的计算和图示

安装

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

$npx skills add https://github.com/szeyu/vibe-study-skills --skill obsidian-notes-creator

安装后在 Claude Code 中输入/obsidian-notes-creator确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
quality-checklist.md
verification.md
references/components/
callouts.md
diagrams.md
frontmatter.md
wikilinks.md
references/structure/
index-note.md
multi-file.md
single-note.md
references/writing/
analogies.md
comparisons.md
examples.md
intuition-first.md
teaching-style.md

详细介绍

Obsidian 笔记创建器

让笔记准确、易于目标读者理解,并能帮助他们解决陌生问题。根据学习者的水平和请求范围调整内容深度;装饰和篇幅都不能证明笔记质量。内容正确但难以阅读的笔记,还不算完成。

1. 检查并选择模式

  • **创建:**选择结构前,先确定来源、受众、先修知识和学习目标。
  • **改进:**阅读现有笔记、相关笔记、资源文件和适用的知识库说明。直接修复并深化这些文件。保留文件名、文件夹、链接、原始日期和有用的作者措辞。除非用户要求或任务确有必要,否则不要创建平行的学习指南、重命名文件或强行采用新的文件夹树。
  • **审查:**指出具体缺漏并提供文件引用;对于仅要求审查的任务,不要擅自改写内容。

了解读者。 写作前,用一两句话说明读者是谁以及他们已经掌握哪些知识(例如:“熟悉 Python 和高中代数,但不熟悉这种记号”)。在此基础上构建解释。如果读者情况不明确,且会影响写作方式,请询问用户。

对于涉及整个文件夹的任务,先盘点所有 Markdown 文件。将每个文件标记为未审阅、审阅后无需更改、已改进或待解决,并简要说明原因。精心打磨少数几篇笔记属于有针对性的处理,并不算完成了整个文件夹的审阅。除非用户要求,否则将这份工作记录保存在笔记之外。

默认设置:答案和解答直接可见;SVG 图示使用白色背景。用户明确提出的偏好优先于这些默认设置。

2. 理解后再扩展

找出缺失的推理、先修知识、假设、定义和误导性说法。区分来源中的陈述、推导出的示例和不确定内容。将来源引用放在其支持的说法附近;绝不编造页码、测量值或实验结果。

优先保证正确性、推理过程完整的解题示范和有用的联系。只有当视觉材料、类比、表格或练习能教会读者现有解释未能传达的内容时,才添加它们。

3. 解释并演示

对于陌生内容,要将动机和直觉与正式表述联系起来。参考笔记可以从定义开始;解题过程可以从问题开始。不强制要求使用类比或图示。

使用朴素清晰的表达:每句话表达一个想法;术语首次出现时先定义;每个论点后紧跟一个示例;先讲具体情况,再给出一般规则;将细枝末节的注意事项移到后续章节,不要打断主要解释。

  • 教学风格:以读者为先的写作、符号解读、从熟悉概念过渡、常见错误、一致的笔记结构、分层讲解、练习类型、整洁的页面布局,以及最后以初学者视角通读检查。

  • 直觉与数学:符号、假设、推导和局限。

  • 类比:明确映射关系及其失效之处。

  • 示例:完整解答、独立检验和诊断性问题。

  • 比较:方法选择、保证和公平的证据。

4. 使用恰当的呈现形式

根据读者需要了解的内容,选择 prose、表格、ASCII、Mermaid 或 SVG。公式使用渲染后的 LaTeX。确保视觉内容与周围的示例保持一致。

5. 如实验证并报告

使用验证工作流和质量检查清单。单独验证计算结果和渲染效果。按预期的嵌入尺寸检查生成的图。检查已更改的链接和资源。

报告覆盖范围、实质性改进、实际运行的检查以及未解决的问题。区分已审阅、已执行和已渲染的内容。切勿仅凭样本、语法检查或文件数量就声称已完成全面验证。

评论

支持 Markdown