至今为止,我已经利用 AI 工具辅助开发了 10 个 Obsidian 插件。这里想要分享我在使用 AI 开发插件过程中经历的失败、总结出的教训以及最终获得的收获。简单来说,AI 给我带来了极大的震撼——作为一个对 TypeScript 这种编程语言了解很少的人,竟能以极快的速度开发出第一个版本的插件,这不仅令我惊艳,也满足了我在使用 Obsidian 对于项目、任务和知识管理方面的需求。

播客版如下:

初衷:需求驱动下的开发探索

最初,我在工作中记录笔记时,总希望能够方便地改变任务状态,并在完成、标记任务等情况下自动附加时间戳。最开始的想法是,假如能在现有插件上提出功能请求,让它们满足我的需求,那就再好不过了。遗憾的是,虽然我提出的部分功能请求很快获得支持,但也有一些拖延了一两年仍然没有被实现。毕竟,开源社区中的开发者往往基于个人兴趣和业余时间开发插件;对于第三方用户的需求,开发优先级自然会有所不同,这点也完全可以理解。作为一个有着实际需求的用户,我最终决定不再等待,而是主动利用 AI 工具开发一个插件来满足自己的需求。

第一次尝试:开发 Task Marker

当我知道 AI IDE 工具 Cursor 推出时,我立刻开始尝试开发插件。当然,当时并不是从零开始,而是基于一个已有的插件—— Task Collector。我先研究了它的代码,然后利用 Cursor 对代码进行了修改和扩展,目的就是让这个插件能方便地改变任务状态(如未完成、已完成、取消、书签等),同时在状态改变时自动添加时间戳,记录任务创建和完成的时间。

在开发过程中,我主要通过对整个代码库进行问答来指导修改。当遇到问题时,我会把错误信息反馈给 Cursor;当 Cursor 无法独立解决时,我还会将故障代码和错误信息发给 ChatGPT,两者结合起来辅助开发。虽然当时 AI 给出的故障解决方案有时存在胡编乱造的情况,但总的来说,它起到了辅助作用,使得开发效率显著提高。现在,Task Marker 已经成为我每天必用的插件。

失败的尝试:开发 Todoist 和 Canvas 插件

在 Task Marker 成功后,我开始尝试开发更多插件,希望借此进一步提高工作效率。首先,我尝试了一个叫做 Todoist Sync 的插件,该插件能在 Obsidian 中便捷地创建任务并同步到 Todoist。但问题在于,这个插件无法实现我在创建任务时将 Obsidian 笔记或任务以链接形式嵌入到 Todoist 任务描述中的需求。尽管我提出反馈并等待开发者改进,但始终没有看到相应的功能更新。于是,我决定采用同样的策略——调研多个现有的 Todoist 同步插件,选择一个相对适合的作为基础,再自行开发。但由于该插件代码库较为复杂,再加上我对 TypeScript 的了解有限,以及 Cursor 内置的 AI 大模型工具等多方面因素,Todoist Sync 插件最终也未能成功开发,项目只得暂时搁置。

接着,我又想尝试开发两个与 Canvas 相关的插件:

  • Link to Canvas 插件:旨在将笔记链接以 block embed 的方式发送到选中的 Canvas 文件中。(后来再次尝试后,开发成功,并且命名为 Send to Canvas。)
  • Canvas 文本框尺寸调整插件:解决在 Canvas 中创建多个文本框后,需要反复手动调整大小和颜色的问题。

不幸的是,这两个插件也都遭遇了失败。例如,在开发 Link to Canvas 时,有时插件能够成功发送文本块,但在处理未完成任务时却无法生成 block ID,导致发送的块无法以嵌入方式显示原任务内容。类似的问题在 Canvas 文本框插件中也频频出现,调整后的格式在关闭并重新打开 Canvas 后全部消失。虽然我多次提供错误日志、控制台提示(如 Obsidian console 中的故障代码和 warning message)以及详细描述预期效果等,但问题始终没有得到根本解决。

转折点:使用更高效的 AI IDE

正当我对 AI 工具的能力产生疑问时,我遇到了另一个更加强大的 AI IDE —— WindSurf。WindSurf 的出现让我眼前一亮,凭借它我开始开发后续的插件,并迅速取得成功。除最初几款基于 Cursor 开发的插件外(Task MarkerCopy MetadataTimestamp Link),后续大部分插件均是借助 WindSurf 快速完成的(Link MaintainerURI ConverterTodoist Context BridgeFile Title UpdaterFolder NavigatorSend to Canvas以及Canvas Format Brush)。

简单的插件甚至能在一小时内完成初步版本,而稍复杂的插件(如 Todoist Context Bridge)也仅用了两三个小时便有了初步可用的原型。WindSurf 不仅从零开始生成了整个项目的代码,还辅助改进了插件的自动化发布流程、文档撰写等工作流,使我大大提高了开发效率。

开发总结与反思

在多次开发实践中,我总结出一些经验:

首先,一定要清晰地描述自己的需求。以开发 “Send to Canvas” 插件为例,我的初始需求是希望能够方便地将笔记中的任务发送到选定的 Canvas 文件中,且发送时需要使用 block embed 的方式。这个过程涉及到检查文本中是否存在 block ID,若不存在则需要创建。最初,我仅简单描述“发送笔记链接到 Canvas”,导致 AI 生成的方案与预期大相径庭;而当我详细说明各个环节时,问题才得以解决。

其次,描述清楚遇到的问题同样重要。在开发过程中,我会遇到有时能发送普通文本但无法为未完成任务生成 block ID 的情况。后来,我不仅用文字描述现象,还附上控制台错误信息和示例代码片段,这样 AI 才能全面理解问题并给出更准确的解决方案。

第三,要提供足够的辅助材料。无论是故障代码、控制台截图,还是从其他插件中借鉴的示例代码,都有助于 AI 更好地理解和解决问题。同时,明确告诉它参考官方 API 文档也能提高兼容性,避免使用不够稳定的非官方接口。

第四,提示词需要逐步迭代和优化。AI 最初给出的版本往往并非完美,因此我需要在交互过程中不断完善提示词,告诉 AI 应尽量使用官方 API,或者借鉴类似插件的交互方式。例如在 Canvas Format Brush 开发中,我要求使用图标而非文字显示子菜单选项;然后又经过多次沟通、测试、微调的过程,才能逐步达到预期效果。

第五,切忌贪多。开发新功能时,不要期待 AI 一次性实现所有功能细节。以 “Send to Canvas” 插件为例,初始版本仅实现了发送文本块和 block embed,而笔记链接功能则在后续版本中补充。先实现核心功能,再逐步完善其他细节,能有效减少开发和修改难度;而降低预期也能够降低失望和减少内耗。

第六,有时需要重启对话。长时间的交互会积累大量错误信息,这可能影响后续解决方案的质量。比如在开发 Canvas Format Brush 时,多次交互无果后,我重新开启新的对话,重新描述需求,最终获得了全新的解决方案。

最后,关注 AI 工具本身的进化。过去两年中,我曾使用过 GPT-3.5、GPT-4、GPT-4o、o1、o3-mini、Claude 3.5、Cluaude 3.7、QWen、DeepSeek 等大语言模型,也用过 VS Code、Cursor、WindSurf 等 IDE 工具。尤其考虑到最近大语言模型推理功能的改进,使得 AI 对复杂问题的理解和反馈能力大幅提升。举例来说,我最初尝试开发 Canvas Format Brush 和 Send to Canvas 插件时,使用 WindSurf + Claude 3.5 均未能成功;但经过数月调整后,借助最新的 Claude 3.7,我重新尝试,结果大获成功,交互次数也明显减少。

开发成果和收获

通过这些开发经历,我的收获不仅仅体现在技术层面,更在于工作流程的彻底改造。比如,

  • Task Marker 插件:现在用它完成任务、标记状态以及附加时间戳;这使得任务管理过程变得更加高效。还用它标记不同任务状态,这对于凸显会议笔记等长笔记中特定内容尤为方便;使得将来再次回顾笔记时,无需从头查看完整笔记内容,而只需关注那些标记了的重点内容,笔记回顾变得更加高效
  • Todoist Context Bridge 插件:过去创建任务并同步到 Todoist,需要手动复制 URI 链接、打开 Todoist 粘贴到任务描述并调整截止日期、优先级等属性。而借助该插件,只需要在 Obsidian 中创建任务,添加 Dataview 或 Tasks 格式的截止日期、优先级等属性,然后直接调用命令,即可一键同步;整个过程无需打开 Todoist。而且,任务从 Obsidian 同步到 Todoist 后,还会在两个位置都插入任务链接,方便互相定位。这使得凸显重要任务、软件之间的交互变得更加高效
  • Canvas 系列插件(Canvas Format Brush、Send to Canvas 等):原来需要手动拖拽调整 Canvas 卡片的大小和颜色;现在只需复制格式,再批量应用到选中的卡片上。原来需要手动复制笔记或者快链接,然后粘贴到 Canvas 文件上;现在只需要选中文本或者笔记,然后调用命令即可将内容发送到 Canvas 文件。这使得笔记的整理和组织变得更加高效

如下几个小插件也都有其各自独特的使命:

  • Timestamp Link:这个插件解决的问题很简单、直接,创建笔记之间的链接很重要,什么时候创建的链接、什么时候建立的链接同样重要。有了这个插件,时间戳信息可以方便包含在 block ID 和笔记链接后面。
  • URI Converter:我们可以把笔记和块链接复制到外部工具,同样也可以反过来做。当我们把 Obsidian URI 从外部工具粘贴回 Obsidian 笔记时,这个插件可以帮你将其转换为内部链接,从而确保知识库中链接有效
  • Folder Navigator:我们可以方便通过搜索的方式定位到笔记库中的笔记;我们也可以通过同样方式方便定位到笔记库中的文件夹
  • File Title Updater):我们有时需要更改笔记名称、内部的标题、frontmatter 中的标题,这个插件可以方便帮你使得不同位置的标题统一化

这些插件发布后,不仅解决了很多我面临的实际问题,也给我带来了巨大的满足感和成就感,也在一定程度上满足了我的“虚荣心”。更重要的是,我发现自己与 AI 交流的能力也大大提升。过去网络上流传的 Prompt Engineering 模板虽然有参考价值,但往往需要根据自身需求进行反复调整。只有清晰、详细地表达需求,才能使 AI 更好地协助开发。当然,我也深知我们不能对 AI 过于贪心。它已经大幅提高了我们的效率,而且未来还会进步。

目前,虽然已发布插件最初设想的主体功能已经开发完成,但仍有用户在 GitHub 上提出新的功能请求。比如,有用户希望 Todoist Context Bridge 能够自动同步 Todoist 和 Obsidian 之间的任务完成状态。虽然我曾尝试两次(当时是 WindSurf + Claude 3.5,如今 Claude 3.7 Thinking、o3、DeepSeek 等模型的功能可能更好),但因为功能过于复杂以及我对细节的过分追求,最终这项功能依然搁置。同时,我还有其他插件开发的想法,自动同步功能可能会在未来的某个时刻实现。

结语和展望

通过开发这 10 个 Obsidian 插件,我不仅优化了自己的 PTKM 工作流,更在反复试错与迭代中积累了和 AI 交互的经验,比如,清晰描述需求、详尽反馈问题、提供足够辅助材料、迭代优化提示以及适时重启会话等。

回顾整个过程,从最初的VS Code 到后来的 Cursor 和 WindSurf,我见证了 AI IDE 工具在软件开发和问题解决上的飞跃。自从 ChatGPT 3.5 发布以来,我便率先体验其魅力。后来,不同公司又逐步发布了 GPT-4、GPT-4o、o1、o3-mini、Claude 3.5、Cluaude 3.7、QWen、DeepSeek 等更加先进的大语言模型。虽然我们对 AI 是否会取代人类充满疑虑,但可以确信的是,它们在不断进步。我们作为普通用户,或许也可以学习如何和他们交互、提升自我,以更好地驾驭这些工具,让他们更好地服务我们的工作和生活。

技术的进步不可阻挡,我们作为普通用户能做的就是不断学习如何更好地和 AI 交互,发挥人类在概念生成和需求表达等方面的独特优势。我们可以选择和 AI 一起进步、一起成长。

最后,希望我的经验分享能为你提供帮助,也期待大家能借此更好地利用 AI 工具,让工作和生活变得更加简单、高效。也欢迎大家分享自己的 AI 使用经验。

相关阅读