插件更新别啥记录都不留,半年后用户问上次改了啥,翻半天代码找不着
新手做网站插件,更新完功能,用户问你改了啥,你啥都记不住,来回翻代码,其实写个简单的更新日志,用户清楚,自己后续维护也方便。第一,每次更新就记三行:这次改了啥功能、修了啥bug、改了哪个文件,别写一大段空话;第二,日志放在插件目录的update.md里,后台更新页面能直接看到,用户点一下就知道这次更新了什么;第三,版本号按顺序排,比如1.0.1、1.0.2,别一会出个2.0,一会出个1.5,用户都分不清版本先后;第四,重大更新写清楚兼容说明,比如这次更新不兼容旧版本,要提醒用户备份再升级,不然更新完全崩。
我之前做插件,更新了十几次功能,用户问我上次改了啥,我翻半天代码找不出来,之后每次更新写三行更新日志,半年后自己看日志,上次改了啥一眼就知道,用户也清楚更新内容。很多新手觉得更新日志是多余的,其实记下来,后期维护省无数次翻代码的时间。
本站源码来源于网络收集修改或者交换,甚至可能并非原创,如遇未经考证信息需持审慎态度。若有疑问,可联系本站处理。
0