大家好,这里是程序员晚枫。
和大家一样,每次听到写文档,我都很头疼。
所以我就想,能不能用大模型来写文档呢?
正好我最近正在迭代python-office这个开源项目,其中一个子项目:popdf的代码注释和项目文档,我就全部用大模型来写了。
其中大模型我用的是:MarsCode编程助手。
需求说明
我开发Python处理文档的开源项目:python-office有5年的时间了,但是因为懒,文档这方面一直做得不好。
然而这个项目主要是给小白用的,所以文档又非常的重要。
所以我这次打算给每个功能都写一篇文档,让大家可以按需使用。
用大模型来实现
1、安装插件
首先在vscode里安装MarsCode编程助手插件。
2、生成文档模板
然后,在插件里输入以下命令:
根据python-office的代码仓库:https://github.com/CoderWanFeng/python-office,给我写一个python-office项目的popdf模块的文档。
3、编辑文档
接下来就是复制粘贴,然后修改细节。
但是在修改的过程中,MarsCode会给你提供文档补全的功能,这大大提高了我的工作效率。
4、结果展示
最后,我把这个项目的文档全部生成完毕,效果非常不错。
可以看到,我用MarsCode来写文档,比我自己写要快很多。
我还把这个项目的文档放到了gitee上,大家可以直接下载使用。
写在最后
技术人更关注技术实现的细节,但是写文档对一个项目来说,也是非常重要的任务。
对于一些重复性的描述,完全可以交给大模型来实现。