成功案例 软著Pro编辑部

软件著作权说明书怎么写?一份从整理到提交都能用的实操说明

软著说明书不是随便截图凑页数,重点是讲清软件做什么、怎么操作、界面有哪些功能。按实际使用流程写,材料会稳很多。

632 次阅读 来源:网络整理

很多人第一次准备软件著作权申请,最头疼的不是填表,而是不知道软件著作权说明书怎么写。网上模板不少,但套上去以后,要么内容和代码对不上,要么全是功能口号,审查员看不到具体操作;也有人一口气放了几十张截图,结果每张图旁边只有“登录界面”“首页界面”几个字,材料看起来很厚,真正有用的信息却不多。

我前几年帮公司集中整理过一批软著材料,踩过补正,也见过代理返工。后来再做就顺了:说明书不用写得像产品白皮书,更不用堆技术架构,核心是把这个软件“是什么、怎么进、怎么用、有哪些功能结果”讲清楚,让一个没见过系统的人照着文档能明白主要流程。

先确认你要交的是哪一种说明书

软著申请里常说的说明书,一般指用户说明书或者操作说明书。有些偏底层、工具型、不方便展示界面的软件,也可以提交设计说明书。普通业务系统、小程序、App、管理平台,我更建议写用户操作说明书,因为界面、流程、输入输出都好展示,材料也更直观。

动笔前先把软件全称、版本号定下来。这个细节看着小,实际上特别容易出问题。申请表、说明书页眉、源代码标注里的名称和版本要一致,不能申请书写“V1.0”,文档封面写“V1.0.1”;也不要今天叫客户管理系统,明天又叫客户关系管理平台。名称改来改去,后面代码文档、申请表、截图标题都得跟着改。

开头别堆概念,先把软件基本情况交代清楚

说明书开头可以放一个简单的软件概述,用几段话说明软件用途、运行环境和主要用户。比如它面向什么业务场景,运行在 Windows、浏览器、安卓手机还是服务器上,主要角色有哪些,解决的具体问题是什么。这里不建议写“赋能行业数字化转型”这类空话,直接写“用于维护客户资料、跟进沟通记录、生成销售统计报表”,反而更清楚。

运行环境要写实,但不要把公司未来规划写进去。Web 系统就写浏览器、服务端环境、数据库等必要信息;App 可以写适配的系统版本;桌面软件写操作系统和最低配置。很多材料被要求补正,不是因为写少了,而是写得太虚,通篇都是先进、高效、智能,偏偏看不出软件到底怎么运行。

如果你同时还在准备源代码、申请表,不确定材料名称和文档格式是否统一,可以用 软著Pro 顺手检查一下材料。它对说明书、源代码分页和申请信息整理比较友好,适合在提交前做一次规范化核对,比自己反复翻 PDF 省事。

正文按真实操作流程写,不要按部门想象去编

我比较习惯从登录开始写,然后按照用户实际使用顺序展开:账号登录、首页、基础资料、核心业务、查询统计、权限管理、退出登录。每个模块先说明用途,再写操作步骤,最后放对应界面截图。比如“客户信息管理”这一节,不要只写“可对客户进行增删改查”,最好写清楚点击哪个入口、填写哪些字段、保存后系统提示什么、列表里如何显示、编辑和删除权限受什么控制。

截图和文字要互相印证。只放图不解释,审查员需要自己猜;只写文字不放图,又缺少操作呈现。正常做法是:一张有代表性的界面图,旁边配两三句话,说明页面区域、关键字段和操作结果。涉及流程的地方,要把前后变化写出来。例如新增订单时填写客户、商品、数量,提交后库存如何变化,订单状态是什么,在哪个列表可以查询到。

截图尽量用完整界面,不要只截一个按钮。浏览器地址栏、系统名称、登录账号这些敏感信息可以遮挡,但软件名称、菜单、字段、按钮最好保留。图片上的字号别压得太小,黑白打印后要能看清主要内容。如果页面中有测试数据,尽量用“上海某某有限公司”“测试客户A”这种中性数据,不要出现真实客户手机号、身份证号、合同金额,后续既避免泄露,也省得临时重截。

功能模块要覆盖主要代码,别只写一个首页

说明书里的功能不要求把每个隐藏接口都讲一遍,但主要模块应该和软件本身、源代码内容能对应上。你申请的是仓储管理系统,就不能整篇只介绍登录和首页,出库、入库、库存盘点、报表这些核心功能都要出现。否则审查员看到代码里有大量业务类名和接口,文档却没有对应描述,就容易觉得材料不匹配。

写功能时也别把还没做的规划放进去。有些产品同事喜欢把二期、三期功能也写进说明书,显得系统很强,但软著材料看的是已完成软件。截图里没有的按钮,代码里没有的模块,最好别写。同理,外部采购的通用组件、开源框架不用大篇幅描述,重点放在你的软件实现了哪些业务功能,以及用户怎样完成操作。

如果软件角色权限比较复杂,建议单独写一节。管理员、普通用户、审核人员分别能看到什么菜单、能做什么操作,最好用一张角色权限界面或者账号管理界面配合说明。很多后台系统的价值就在权限和流程上,这部分写清楚,说明书的完整度会明显提高。

异常情况、查询结果和报表,是最容易被漏掉的内容

不少说明书只写“填写信息,点击保存”,但没有写保存成功后的反馈,也没有展示查询、筛选、详情、导出等结果页面。实际上这些内容很重要,因为它们能证明软件不是静态页面,而是有数据处理逻辑的。

比如查询模块,可以写输入客户名称或选择时间范围后,列表如何加载符合条件的数据;详情页展示哪些字段;报表页用表格或图表展示哪些统计指标;导出按钮生成什么格式的文件。异常提示也可以适当写,比如账号密码错误、必填项为空、库存不足时系统给出提示。不用每种异常都罗列,但关键业务节点有一两处,会让文档更像真实操作说明。

对于涉及硬件、算法或数据处理的软件,还可以补充数据来源和处理结果。例如设备采集数据后上传到平台,平台如何解析、存储、告警和生成记录。这里不需要贴大段公式,除非确实是软件的核心创新;软重在表达,不是发明专利,不必把说明书写成学术论文。

格式和排版别拖后腿,提交前重点核对这些地方

常见的说明书页数一般在三四十页上下,但这不是硬指标,别为了凑页数去放大截图或重复同一页面。真正标准是内容完整。页数太少,只有三五页,可能无法体现软件功能;页数太多但重复啰嗦,也没有必要。一般每个主要功能有说明、有步骤、有截图,前后流程能连起来,就够用。

排版上建议封面写软件全称和版本号,页眉也保持一致;正文用统一标题层级,图片编号连续,比如“图3-2 客户信息列表”。截图不要带个人微信、桌面通知、浏览器无关标签。有些同事做材料时直接拿演示 PPT 截图交差,上面还有大红箭头和批注,这种就不适合放进正式申请材料。

提交前我通常会做四件事:第一,核对软件名称、版本号在所有文件里是否一致;第二,按目录点一遍截图,确认每个核心模块都出现;第三,遮住敏感信息后再导出 PDF,看黑白状态下是否清楚;第四,把源代码包名、类名和说明书功能大致对照,尤其是登录、用户、订单、报表这些关键词,不要两边完全不像同一个系统。

如果你想提高整理效率,也可以试试 软著Pro 这类专门处理软著材料的工具。它不是替你编造功能,而是帮你把文档、代码和格式这些机械工作理顺。软件内容还得来自真实系统,但至少分页、页眉、命名这类琐碎问题不用全靠手动磨。

被要求补正时,先别急着推翻重写

我遇到过一次补正,意见大意是说明书功能描述过于简单,操作界面与软件功能对应关系不足。后来检查发现,问题并不是软件不能申请,而是每个模块都只放了一张图,文字说明太少,核心流程没有闭环。我们按操作路径补全了新增、编辑、查询、详情和结果反馈,又统一了截图标题,再提交就顺利了。

所以看到补正意见,先判断是名称不一致、材料格式问题,还是功能表达不足。若是功能问题,就围绕审查意见补具体操作,不要只增加夸张宣传语;若是格式问题,按要求调整页眉、版本、清晰度和文件完整性即可。说明书本质上是一份证明材料,稳定、清楚、可核对,比辞藻漂亮重要得多。

写软著说明书时,把自己当成第一次使用这个软件的人。你能不能照着文档从登录走到核心业务,能不能看懂每个页面输入什么、系统返回什么,能不能从功能描述里认出这套源代码对应的系统。把这些问题回答好,软件著作权说明书基本就不会写偏。更多材料整理环节,也可以通过 https://ruanzhu.pro 看看现成的规范工具和处理方式,适合在正式提交前查漏补缺。

赞助商内容