政策动态 软著Pro编辑部

申请软件著作权时用AI生成的软件接口文档怎么调整才符合官方要求?

做过十几次软著申报,踩过好几次AI生成接口文档的坑,今天把调整方法、避坑点全说清楚,帮你省掉来回补材料的时间。

829 次阅读 来源:网络整理

我前前后后帮公司和身边朋友报过二十多个软著,最开始不知道用AI省时间,每个项目的接口文档全手动写,十几个接口要整理参数、写示例、排格式,忙一下午才能弄完,后来试着用AI生成初稿,第一次提交就踩了大坑,三个软著全被打回,理由全是接口文档和提交的源代码不匹配。

其实AI生成接口文档本身是真的好用,你只要把swagger导出的json或者接口的基础说明丢进去,几分钟就能出个结构完整的初稿,比手动写效率高太多,但绝对不能直接原封不动提交,我踩过好几次坑之后,慢慢摸出了一套调整方法,现在改完的文档基本都是一次过审,不用来回补材料。

首先要改的就是AI最容易出问题的参数部分。AI生成的内容大多是通用模板,比如你做的是校园教务系统的学生信息查询接口,AI可能给你把参数写得非常笼统,甚至参数名和你代码里的都对不上,你代码里用的是student_no,AI可能给你写成stu_id,这种问题是审核时的重灾区,一查一个准,直接就会被驳回。我之前第一次提交的时候就是没注意到这个问题,后来还是在软著申报交流群里看到有人提,才知道参数名必须和源代码里的完全一致,连下划线和大小写都不能错,参数的类型、必填标识、功能描述也要和代码里的注释完全对应,不能随便写通用内容。

改完参数之后,就要替换所有的示例内容。AI生成的示例很多都是凑数的,甚至会出现和你行业完全不沾边的内容,比如你做的是餐饮收银系统的下单接口,AI给你的返回示例里出现了“淘宝商品ID”“快递单号”这种内容,那你提交之后肯定过不了。你要把所有的请求示例、返回示例都换成你自己实际测试的内容,哪怕是测试环境的假数据也没关系,只要符合你自己的业务场景就行,比如你做的是宠物医院管理系统,请求示例里的宠物名可以写“年糕”,品种写“布偶猫”,这种有具体业务特征的内容,审核的人一看就知道是你自己的东西,不是套的通用模板。如果你不知道标准的接口文档格式是什么样的,可以去软著Pro上面找对应行业的过审模板,都是已经通过审核的案例调整出来的,比AI瞎生成的通用模板靠谱多了,我后来改文档的时候都会先找对应模板参考,省了好多猜审核要求的时间。

还有个很容易忽略的问题,就是AI生成的文档结构经常乱七八糟,有的接口写了错误码说明,有的没写,有的接口参数是必填的在前,有的是可选的在前,排版也忽大忽小,看起来就像是随便凑出来的。你要先统一整个文档的结构,每个接口都按照固定的顺序来写,我一般是按“接口名称、接口功能说明、请求URL、请求方式、请求参数、返回参数、错误码说明、请求示例、返回示例”这个顺序来,所有接口的标题层级、字体大小、段落间距都统一,不要有的用一级标题有的用三级,看起来乱糟糟的。很多人以为接口文档写得越长越好,凑个二三十个接口就容易过审,其实根本不是,审核的人不看你接口数量多少,只看你写的内容是不是和你提交的软件对应,你哪怕只有5个接口,每个都写得清清楚楚,比你凑20个全是通用内容的接口强多了。

我上次帮一个做小程序的朋友团队报软著,他们一共就8个接口,用AI生成的初稿里全是套话,还有不少其他行业的内容,我帮他们改了不到两个小时,把每个参数都和源代码对齐,示例全换成他们自己测试的内容,结构也统一调整好,提交之后三天就收到了初审通过的通知,一点问题都没有。改的时候还要注意把AI生成的那些没用的废话全删掉,比如什么“本接口支持高并发、分布式部署”“兼容多端调用”这种和接口本身功能无关的内容,审核的人根本不关心你这个接口的性能怎么样,只关心这个接口是干什么的,参数是什么,和你提交的软件是不是对应的。如果实在不知道哪些内容该留哪些该删,可以对照软著申报材料的要求清单一条一条筛,不符合要求的内容直接删掉就行,不用怕内容少。

还有个很小的细节我之前踩过坑,AI生成的文档里接口URL经常默认用http://localhost:8080这种本地测试地址,我之前没改就提交了,结果被打回来,要求提供实际的请求路径,哪怕是测试环境的正式路径或者上线后的路径都可以,不要用本地调试的地址。还有错误码的部分,AI经常会给你列一堆通用的错误码,比如200成功、500服务器错误、404接口不存在,这些通用的你可以留着,但你自己定义的业务错误码,比如4001用户未登录、4002余额不足,这些必须要写进去,而且要和你代码里的错误码定义完全一致,这个也是审核的时候会重点核对的点。

现在我报软著基本都是先用AI出初稿,然后花一两个小时调整这些内容,比之前全手动写快了至少三倍,出错的概率也低很多,之前手动写的时候经常漏写参数或者写错参数类型,现在AI初稿都会把所有参数列出来,我只要核对是不是和自己的代码一致就行,省了好多机械性的工作。

赞助商内容