我是一位软件工程师,用通义灵码个人版vscode插件的workspace做项目分析和复盘,对比之前没有灵码,现在提效了80%,使用的具体流程如下。
插件安装和登录
关键字搜索“Tongyi Lingma"安装插件,然后点击工具图标
(vscode侧边栏),打开插件,点击左侧交互区域最下方的登录高亮链接,打开浏览器的登录页面,完成登录,提示登陆成功,即可返回vscode
此时对话框不再是禁用状态,说明登录成功
打开项目
在项目目录的terminal输入code .或者使用vscode的文件-打开目录,打开所需要分析和复盘的项目
我所测试的项目,是一个刚刚结束冲刺期的开发中项目。它是一个类似monorepo的项目,包含多个单独部署的项目,同时包含前端和后端的代码,使用ts开发,部分前后端的数据结构实现了复用。
输入提示词 - 切记@workspace
例如我的提示如下:
@workspace 分析项目架构- 以md模式输出
等待助手思考和输出
例如测试项目的输出如下
部分架构解析如下
可以看到,灵码高效的发现了项目是一个多模块的前后端monorepo,并分析出了前端和后端使用的技术栈:框架、数据库、语言、涉及到的cicd、容器化部署等。不仅仅是一个概要的依赖分析,例如前端选用vue3还指出了组件库是antdv,构建工具是vite,typescript作为编程语言。
入库
复制生成的md文件内容,在项目下新建一个architecture.md文件,将内容复制进去,进行commit提交,即完成了当前节点的项目架构复盘分析。
审计
有时候,使用第三方的工具扫描项目/本地文件,是存在一定的风险担忧的,灵码就很贴心的标出了所参考的内容,展开reference即可看到如下内容
整个过程也是清晰透明的
总结
使用通义灵码,快速生成了项目的架构文档,比我自己一个个的总结更加高效快速。更重要的是,它可以随着项目的继续开发扩展,自动的完成扩展,再也不用担心漏掉什么了!