用cursor开发,应该先写文档,再写代码
文档质量越高,代码质量越好。
怎么搞到高质量需求文档和技术方案,分析一下我的经验。(从头开发一个新项目)
1.需求文档
扣子有个AI生产应用功能,它的流程是,输入功能创意,设计功能,需求澄清,制定视觉风格,制定交互原型,生成 App。
其中需求澄清这步生成的需求文档很棒,各个功能说的都很清晰,还有流程图什么的。 中间的流程按步骤走完,让它生成代码。
试用一下,如果基本符合预期,把它的需求文档下载下来,备用。
2.技术方案文档
根据代码反向输出技术方案
它实现的代码数据都是写死的,假的,它不会考虑调接口。所以要让AI再改一版。提示词大概是这样的
创建api目录,实现各个功能需要的接口函数,只需要创建,并写输入输出的注释,不需要真的实现。
并将目前写死的数据都改为基于接口的。按钮调用接口函数。
这样就有了接口的定义了。
再自己看一下代码,如果没什么大问题,就把代码下载下来。
在cursor中打开项目,让cursor根据需求文档和已实现的代码,看接口实现的是否齐全,接口定义是否符合预期。提示词一个一个来,一个有结果了再进行下一个。
- 为各个页面中涉及到的数据请求接口写一个接口文档,放到docs目录中
- 目前各个页面的功能,与需求文档是否存在不一致?
- 是否存在api接口缺失,缺失的api接口在接口文档 @api-documentation.md 中是否缺失?如果文档中确实则补齐
- 基于 各页面详细分析 需求文档 接口文档,再反向输出一份技术实现方案文档
- 基于 @technical-implementation-plan.md 这个技术方案还有已经实现的的代码和需求文档 @prd-651665816066-v5.md ,再给出一份基于uniapp和unicloud的技术方案。(这里就要把你需要的技术栈替换一下)
- 检查 @uniapp-unicloud-implementation-plan.md @api-documentation.md @prd-651665816066-v5.md 这3个文档之间是否存在不一致的地方,是否能做到互相支撑且闭环。
然后再根据自己的实际情况,要求命名规则什么,再修改文档。
这样就得到了一份高质量的技术实现方案了。
这个文档肯定要自己仔细读一遍的,需求文档也是,都要仔细读一遍,确认没有问题。
3.开发自己的代码
根据自己的技术栈创建项目,把刚刚得到的需求文档、接口文档、技术方案都复制到新项目中。
提示cursor
基于 docs 中的文档,实现需求和功能
这样功能开发出来的功能质量就很好了。然后修改功能和bug,可以让cursor先修改文档,或者你自己修改文档,然后再让cursor实现代码。
4. 开发其他项目
开发其他项目时,需求文档最好还是用上面的方法获取。但是技术方案可以用之前的作为模板,让ai模仿。
最后
目前我基于这套流程开发了2个app了,感觉还不错。
开发的是功能不怎么复杂的工具,因为在学英语,都是跟英语有关的工具,我自己每天也都在使用它们。
不知道去哪里能学到更多更好的cursor使用技巧,所以分享一下希望有更多的交流。
希望我们能成为“汽车”时代更好的“司机”,不要被时代抛弃。