政策动态 软著Pro编辑部

软件著作权说明书怎么写?从材料结构到代码文档避坑实操

软著说明书不是功能广告,写清软件用途、技术架构、核心功能和操作流程更重要。结合申报经验,聊聊文档、代码材料常见坑。

233 次阅读 来源:网络整理

很多人第一次准备软署材料,最卡住的不是申请表,而是“软件说明书到底怎么写”。网上能搜到不少模板,但真把模板套到自己的系统上,往往会发现内容要么空得像宣传页,要么技术细节堆得没人看得懂。我整理过几次软著申报材料,也帮同事改过文档,最直接的感受是:审查材料讲究的是完整、一致、可核对,并不要求你把产品写得多么厉害。

先把一个概念说清楚。软著申请里常说的说明书,一般可以提交操作说明书、用户手册,也可以提交设计说明书。具体选哪种,要看软件本身的形态。普通后台管理系统、小程序、App、SaaS平台,用用户操作手册会比较顺手;如果是偏底层的算法模块、中间件、嵌入式程序,没有那么多页面可截图,设计说明书反而更容易写清楚。不要为了凑页数硬选一种,材料能说明软件是什么、怎么运行、具备什么功能,才是关键。

一份比较稳妥的说明书,开头先交代软件的基本信息:软件名称、版本号、运行平台、开发环境、面向对象和主要用途。这里最容易出问题的是名称和版本。申请表里的名称、说明书封面、源代码注释里的名称,最好保持一致。比如你申请的是“某某库存管理系统”,文档里不要一会儿写“仓储平台”,一会儿又写“ERP系统”。版本号也一样,除非有特殊情况,第一次申请通常用V1.0就可以,后面文档截图、登录页标题、程序标识都尽量对应上。

写完基本信息,接下来不要急着放一堆宣传语。我见过有人直接把公司官网的产品介绍复制进去,通篇都是“高效、智能、赋能、领先”,但审查人员看不到具体功能。更实用的写法是用朴素语言说明软件解决什么问题。例如一个门店订货系统,可以写它用于商品资料维护、客户下单、订单审核、发货跟踪、库存查询和统计报表;再说明它运行在浏览器或移动端,数据如何录入、流转和查询。几句话把业务场景讲明白,比夸张描述有用得多。

功能模块部分是说明书的核心,但不建议只列功能名称。可以按实际使用顺序展开:登录与权限、首页或工作台、基础数据、业务处理、查询统计、系统设置。每个模块下面再写用户能做什么、页面上有哪些字段和按钮、提交后系统如何反馈。比如“新增客户”页面,不能只写“支持客户管理”,而要写用户点击新增后,需要填写客户名称、联系人、电话、所属区域等信息,系统校验必填项和手机号格式,保存成功后列表自动刷新,保存失败时提示原因。这种描述和截图对应起来,材料就很扎实。

截图要讲究真实和清晰。有些人为了页面好看,专门做一套高保真原型图交上去,结果截图里没有登录状态、没有数据、没有真实菜单,和软件运行环境也对不上。我的习惯是用测试账号搭一套演示数据,把订单、商品、客户、报表等列表填得相对完整,再统一截图。浏览器地址栏、系统名称、菜单层级、弹窗提示都可以保留,关键信息注意脱敏。截图不要只放图,每张图下面配一两句说明,告诉审查人员这个页面的用途和操作路径。

操作流程部分可以挑几条主线写,不一定要把每个按钮都讲到。比如从登录、录入基础资料、创建业务单据、审核、查询到导出报表,按顺序配截图,就足以体现软件的主要运行过程。写流程时要避免前后矛盾。前面说订单审核后才能发货,后面截图里却出现未审核订单直接发货;文档里角色只有管理员和普通用户,截图里又冒出财务主管、代理商,这些细节都可能让材料显得不可信。

如果提交的是设计说明书,重点就要从“怎么点按钮”转到“怎么实现”。通常需要写系统架构、模块划分、数据流、接口或数据库设计、关键算法、异常处理等内容。Web系统可以简单说明前端、服务端、数据库之间的关系;嵌入式或硬件相关软件,要说明运行设备、通信方式、控制逻辑和数据采集过程。这里也不建议贴大量无法解释的代码,设计文档应该让人看懂技术思路,源代码材料本身才承担程序表达的作用。

说到源代码材料,很多人也会在这里踩坑。一般要按要求准备前后连续的源代码,页眉通常标注软件名称和版本号,每页保留一定行数,不足全部代码量的按要求提交前、后各一部分。最忌讳从网上复制通用代码,或者把自动生成的重复框架代码塞进去。代码里最好能出现与业务相关的实体、方法、接口命名,比如Order、Inventory、Customer之类,和说明书的模块能相互呼应。删除真实密钥、内网地址、敏感账号信息,但不要删得前后不连贯。

文档语言风格也值得调整。软著说明书不是投标方案,不需要堆架构概念;也不是测试报告,不用列大量测试用例;更不是营销文案,别把“行业领先”“极大提升效率”当成主要内容。你可以把读者想象成一个不了解你业务的人,他只通过材料判断这是不是一个独立、可运行、功能明确的软件。按这个标准去写,很多内容自然就会落地。

格式上,我建议提前统一封面、目录、标题层级、截图编号和页码。封面写软件全称、版本号、公司或个人名称、完成日期;目录能帮助审查人员快速找到模块;正文标题不要超过三级,否则自己后面改编号都麻烦。截图宽度尽量统一,字体不要太小。文档完成后,从头到尾按菜单点一遍,再核对申请表中的开发完成日期、发表状态、权利取得方式、运行环境等信息。很多补正不是因为软件多复杂,而是名称不一致、文档缺页、截图无法辨认、功能描述过于简单。

如果你第一次做,心里没底,也可以先用一些在线工具辅助整理材料。比如 软著Pro 就适合顺手查一下材料清单、文档要求和申报注意事项,至少能在提交前帮你发现格式和内容上的明显问题。不过工具只能提高效率,说明书里的业务模块、操作路径、截图数据,还是要基于自己的真实软件来准备。

最后说一个实际经验:不要等软件全部开发完才想起补文档。开发过程中顺手保留测试账号、页面截图、版本记录和核心代码,申报时会轻松很多。写说明书时也别追求一次成稿,可以先把系统菜单和业务流程拉出来,再逐页补截图、补说明,最后统一名称、版本和术语。只要材料真实、结构完整、前后一致,软件著作权说明书并没有想象中那么玄乎。

赞助商内容