如何用 Cursor 在一个大项目上更高效地工作?

教程2个月前更新 Carey
0

如何通过良好的项目管理实践和工具配置,让AI助手(Cursor)在大项目中发挥更大作用?

以下总结了很多,最后一点也很重要。

本文关键词:
  • 文档管理的重要性
  • 渐进式开发的方法论
  • 代码库索引维护

1、使用 Cursor Rule

如何用 Cursor 在一个大项目上更高效地工作?

添加项目必需的技术栈相关的 Rule

访问 github上的Awesome Cursor rules[1],选择适合你项目技术栈的规则。上面几乎包含目前所有流行的技术与框架。

如何用 Cursor 在一个大项目上更高效地工作?

确保你的项目管理要求

在 .cursorrules 中,确保包含下面的内容:

Project Management: 
- 所有功能实现应参考 PROJECT.md
- 所有API端点及其请求/响应格式参考 Documentation.md 
- 确保新代码符合定义的里程碑 
- 遵循已建立的数据库架构 
- 考虑指标中定义的成本优化 
- 保持与现有组件的一致性 

2、使用 Notepad

Notepad 功能目前 (205.04) 还是 beta 阶段,所以你需要在 Cursor 的配置中打开。

如何用 Cursor 在一个大项目上更高效地工作?

这样,你就可以在左面板中增加下面两个 Notepad 了(当然,你可以添加你自己的 Notepad)。

  1. ‘sync’: 停下来整理思路,检查是否已更新 @project.md 和 @progress.md(如果需要的话),确保你知道我们目前进展到哪里了,然后我们再进入下一步。先不要开始编码。
  2. ‘Get to up’:  检查 @project.md 和 @progress.md 并充分理解我们的项目和进展 – 基于此建议下一步行动。先不要开始编码

然后我会定期在编辑器中输入 @sync 作为提示。有时在 New Chat时,也会这样做。

如何用 Cursor 在一个大项目上更高效地工作?

3、使用项目里程碑文档管理项目进度

创建一个 Project_milestones.md 文件,并在 .cursorrules 文件中引用它。

尽可能详细地告诉Cursor你的项目范围和需求,让它生成一个项目文件。在每个会话结束时(或在会话期间),让Cursor更新该文件,标记已完成里程碑和学到的经验。

 

4、使用技术说明文档来记录相关的实现内容。

创建一个 Documentation.md 文件,并在 .cursorrules 文件中引用它。

该文档中应该记录本项目的技术架构与实现。你要确保让 Cursor 定期更新(或让Cursor自行更新)新加入或修改过的函数、架构等。

 

5、定期对项目代码库进行重新索引。

设置索引的位置在 Settings -> Cursor settings -> Features

因为,随着代码库的扩展,你会注意到Cursor有时会引用已删除的文件/文件夹/函数,重新索引有助于防止这种情况。我遇到过 Cursor 忘记已将函数从一个文件移动到另一个文件,并继续在旧文件中建议修复,导致了一系列我最初没有注意到的问题,而且不止一次发生这样的事情。

 

6、循序渐进地工作。

Cursor 目前还只算是掌握大量知识的实习生。不要要求 Cursor 做巨大的功能更新, 例如“给我写 XX APP”。而是指导 Cursor 使用project.md。或者你直接要求 Cursor,”现在,让我们开始下一个功能, 1.2 blahblah “,它总能遵循里程碑顺序进行。

 

7、做好版本管理

一旦达到了一个成功点,要提交代码。你可以让它总结最近的修改。

 

8、你还可以做这些

  • 在项目根目录创建 this.log 文件,并始终将调试日志复制/粘贴到该文件中,然后在聊天中引用它。如果你直接将错误日志粘贴到聊天对话中,很快 Cursor 的上下文就会被破坏了。
  • 当你想要添加或修改一个复杂功能时,与其自己分解任务并只给出下一步要做什么,不如先向它完整地解释整个功能,让它在不涉及代码的情况下制定一个高层次的计划,然后对计划提出改进建议,最后再让它开始实施。
  • 增加一个 code rule, 让代码文件不要超过 500行。

 

9、结语

这么做还有一个好处,那就是文档也在过程中生成了,而且比较详细。如果你有文档模板要求,也可以让 Cursor 遵循你的要求。

© 版权声明

相关文章