文章

Cursor Notepads 最佳实践总结

见字如面,与大家分享实践中的经验与思考。

在过去半年使用 Cursor 的开发过程中,逐渐发现 Cursor Notepads 是连接 Composer 和 Chat 交互的绝佳工具。它不仅仅是 cursor rules 的升级版,更提供了一系列强大功能:

  • 跨环境共享上下文:在 Composer 和 Chat 之间无缝传递知识

  • 附加文件资源:可以关联文档、图表等参考资料

  • 创建动态引用:通过简单的 @ 语法链接到其他资源

  • 构建灵活内容:根据项目需求组织和结构化团队知识

"在我看来,Notepads 是项目思想、团队规范和文档的集合点,为开发工作流提供可复用的上下文。"

img

最佳实践

01 项目知识与架构管理

在团队开发中,经常因缺乏统一认知而导致的问题。Notepads 可以很好地解决这个痛点。

实践要点:

  • 记录关键的系统设计决策和技术选型理由

  • 构建清晰的模块关系图和接口文档

  • 建立团队统一的知识库,减少沟通成本

示例结构:

# 系统架构概览
​
## 核心技术栈
- 前端:React 18.2 (选择理由:团队熟悉度高,生态完善)
- 后端:Node.js 18 LTS (选择理由:与前端技术栈统一,降低学习成本)
- 数据库:MongoDB 6.0 (选择理由:适合快速迭代的文档结构)
​
## 关键模块与接口
- 认证模块:JWT 方案,详见 @auth-flow.md
- 数据模块:MongoDB 模式设计,详见 @data-schema.json
- API层:RESTful 接口,详见 @api-spec.yaml

实际案例:

在 Cursor Chat 中引用架构文档:

请参考 @系统架构概览 给出用户认证模块的实现方案

通过引用 Notepad 内容,可获取项目架构信息,确保团队遵循统一的设计规范。

02 编码规范与模板库

统一的编码规范对项目维护是非常重要的。

实践要点:

  • 建立团队共识的代码风格指南,而非个人喜好

  • 收集项目中反复出现的代码模式和最佳实现

  • 整理可复用的解决方案,提高开发效率

规范示例:

# API开发规范
​
## 端点结构
- 坚持RESTful约定,保持接口的一致性和可预测性
- 基础URL:`/api/v1`,便于未来版本升级
- 资源命名使用复数形式(如users, products)
​
## 响应格式
{
  "status": "success|error",
  "data": {}, // 成功时返回的数据
  "message": "操作成功/失败的具体描述"
}
​
@api-examples.json // 附带真实示例

实际应用案例:

在 Cursor Chat 中引用规范文档:

参考 @API开发规范 帮我重构用户资源的CRUD接口,需要兼容新的权限系统

这样生成的代码完全符合团队标准,避免了后续的反复修改,节省了代码审查的时间。

什么内容适合放进 Notepads?

以下内容最适合记录在 Notepads 中:

适合的内容类型

  • 项目架构决策和背后的思考逻辑

  • 团队约定的编码规范和标准

  • 经过验证的代码模板和实用示例

  • API文档和关键技术规范

  • 新成员入职指南和环境配置说明

不适合的内容类型

  • 任何敏感凭证和密钥信息(安全风险)

  • 随手记录的临时笔记或想法草稿

  • 应该存放在Git等版本控制系统中的核心代码

  • 变动频繁且不稳定的信息

内容格式经验分享

好的 Notepads 通常具有这些特点:

  • 使用清晰的标题和层次分明的章节

  • 包含实际项目中可直接使用的示例

  • 内容专注且有明确的组织结构

  • 巧妙运用 Markdown 格式提高可读性

  • 适当添加图表或文件附件增强理解

Cursor Notepads 与 Cursor Rules 如何取舍?

在实际使用中,我总结了这两个功能的差异:

特性

Cursor Notepads

Cursor Rules

适用场景

复杂知识管理、团队协作文档

简单 IDE 配置、基本规则

支持附件

✅ 支持

❌ 不支持

动态引用

✅ 支持 @ 语法

❌ 有限支持

最佳用途

深入指南与知识库

简明规则与配置

我的选择建议:

  • 当需要构建团队知识体系、包含附件和复杂内容时,选择 Notepads

  • 当只需设置简单的编码规则和IDE配置时,选择 Rules

  • 在我们团队,这两者通常是互补使用,Rules 中会引用 Notepads 的详细说明

结语

Cursor Notepads 能显著提升团队协作效率和知识管理水平。它解决了团队成长过程中知识传承和标准统一的核心问题。

特别是在多人协作的复杂项目中,清晰的文档结构、实用的示例代码、条理分明的内容组织,再加上 Markdown 的灵活格式和必要的附件支持,让 Cursor Notepads 成为我们团队开发流程中不可或缺的支撑工具。

在我们的开发实践中,Notepads 与 Rules 形成了互补优势。我们在 Notepads 中维护详尽的编码规范、架构文档和设计指南,同时通过 Rules 实现基础的行为约束。这种组合极大提升了团队效率,既保证了代码一致性,又不失灵活性。

Cursor 系列精选阅读

如果你对 Cursor 感兴趣,可以按学习路径浏览我的更多专题文章:

入门篇

进阶篇

设计与开发实战


欢迎关注我的公众号"Eric技术圈",原创技术文章第一时间推送。

License:  CC BY 4.0