简介:软著申请材料中,软件说明书往往是审查重点。这份资源以《软件著作权申请中的软件说明书编写指南》为核心,提供一套可直接套用的 Word 模板,面向需要办理软件著作权登记的开发者、团队及知识产权代理人员,用于快速生成格式规范、内容完整的说明书,降低因材料不规范导致的补正风险。压缩包共 1 个 docx 文件,约 14KB,内含封面与著作人信息、目录、产品功能介绍、系统登录与注册说明、权限管理、异常处理、更新日志及联系方式等章节框架;模板以“Xxxxx 系统 v1.0.0”为示例,逐节标注了界面截图、使用步骤、技术栈等填写位置,并附撰写指南,帮助使用者理解每部分应写什么、如何写。已有 2403 人浏览学习。适合软著申请初学者或急需出稿的开发者参考,按模板填充即可形成较为完整的说明书。
1. 软著申请里的说明书模板:一遍过的关键不是代码而是描述
软著申请最容易被退件的材料,往往不是源码包而是这份软件说明书。很多开发者代码写得利索,却在“产品前端功能使用说明”这一节栽了跟头——截图模糊、步骤粒度太粗、技术栈堆名词,每一项都可能换来一封补正通知书。这份以“Xxxxx 系统 v1.0.0”为示例的说明书模板,把封面著作人信息、目录、登录注册功能说明和技术栈四块核心内容做了结构化拆分。照着模板逐项填充,能明显减少来回修改的沟通成本。适合独立开发者和小团队申报软著时直接套用。
2. 说明书整体框架:封面、目录与著作人信息的规范写法
2.1 封面要素:软件全称、版本号、著作人一个都不能少
审查员拿到说明书之后翻的第一页就是封面。封面不需要花哨设计,但四个信息必须齐全:软件全称(如“Xxxxx 系统 v1.0.0”)、文档类型标识(即“软件使用说明书”)、著作人(企业名称或姓名)。如果提交主体是个人,著作人位置写个人姓名;如果是企业,写企业全称。这里最容易出的问题,是封面软件名称与申请表软件名称不一致。申请表写的是“某某系统”,封面写成“某某系统管理平台”,虽然只差几个字,审查员完全可以认定为两份不同的材料,直接补正。
我在实际填写时,会额外在封面右下角补一行“文档版本:V1.0”和编制日期。这行信息虽然不起眼,但当软件迭代过多个版本后,它能帮你快速回忆这次提交用的是哪一版说明书,补正时不用重头翻源码确认。
模板的封面格式可以按下面这个纯文本结构组织:
Xxxxx 系统 v1.0.0 软件使用说明书 著作人:企业名称或姓名 目录 一、产品概述 二、运行环境 三、产品前端功能使用说明 3.1 系统登录功能说明 3.2 系统注册功能说明 四、技术栈说明这里的“著作人:企业名称或姓名”是模板占位符,提交前必须替换成实际申请主体。封面信息一旦确定,后续补正环节不能随意更换,所以首次填写就要把软件全称、版本号和著作人统一核对到位。
2.2 目录设计:按用户操作路径而不是代码结构
模板目录里只有“产品前端功能使用说明”一个一级章节,底下挂登录和注册两个功能说明。这种结构虽然简单,但组织逻辑是成立的——按用户的操作路径来排功能,而不是按后端 Controller、Service 的代码结构来排。审查员关心的是“这个软件能干什么、用户怎么操作”,不是“这个软件怎么实现的”。
一份完整的说明书,目录至少应包含四到五个一级章节:产品概述、运行环境、功能介绍、技术栈说明、异常处理与联系方式。功能介绍部分如果模块多,按用户角色或业务场景拆二级章节,比如“前台用户功能”和“后台管理员功能”。每个功能在目录里要有明确位置,审查员定位时不用来回翻。
目录的页码也是容易翻车的地方。用 Word 写说明书时,如果最后改过正文,忘记更新目录页码,提交的 PDF 里目录和正文位置就对应不上。提交前重新生成一次目录并滚动检查几处关键页码,是小成本大收益的习惯。
2.3 命名与版本号的三项硬规则
模板里的软件名是“Xxxxx 系统 v1.0.0”,版本号采用“主版本号.次版本号.修订号”的三段式,这是推荐写法。有人写“V1.0.0.1”四位版本号,有人写“1.0 beta”带修饰语,这两种都不建议用在软著材料里。版本号应当规整、唯一,与源码文档和申请表中的版本号完全一致。
软件名称要能体现用途和类型,比如“仓库管理系统”“在线课程学习平台”。如果公司内部叫“后台管理系统”,建议在软著材料里写全称,比如“某某企业后台管理系统”,这里的“某某”用实际产品线名称替代。名称一旦提交,后续补正时不能随意更换,所以第一步就把名称定清楚。
2.4 说明书页数与排版参考
软著说明书没有全国统一的页数标准,但各地版权中心普遍接受的页数范围大致在 15 页到 60 页之间。页数太少显得内容单薄,页数太多则阅读负担大。按模板的结构估算,登录和注册各写 1 到 2 页,产品概述 1 到 2 页,运行环境 1 页,技术栈说明 1 到 2 页,一个小型软件整体在 20 页左右比较均衡。
排版上,正文用宋体或微软雅黑,字号不小于五号。截图下方加图注,格式如“图1-1 系统登录界面”,编号与章节号联动,这样即使截图清晰度稍差,审查员也能通过文字理解界面内容。页眉可以标注软件全称和版本号,页脚标注页码,整体规范度会明显提升。
2.5 产品概述:四百字讲清软件定位
模板没有单独放“产品概述”章节,但实际申报时这一节一定要补。产品概述放在目录之后、功能说明之前,篇幅控制在 400 到 600 字。内容包含三块:软件解决的业务问题、适用对象、核心功能清单。业务问题用两三句话说清,比如“本系统面向中小型仓储企业,提供库存管理、订单处理和盘点报表功能,替代手工记账”。适用对象写明角色,比如“系统分为管理员和普通操作员”。核心功能清单一段话列完,不展开。
产品概述的写作标准是:让一个完全不了解业务的人读完能说出“这是给谁用的、解决什么问题”。写完可以让同组不参与该项目的同事读一遍,他能在 30 秒内复述出软件定位,这段就合格了。如果软件经历过多次版本更新,还可以在说明书末尾补一页更新日志,写明各版本的变更日期和主要变更内容,让审查员对软件演进过程有整体印象。
3. 功能使用说明:从登录与注册看三段式写法
3.1 功能说明的通用结构:截图、步骤、技术栈
模板里每个功能项都包含三块:界面截图、使用说明、技术栈。这个结构对应了审查员评估功能的三个信息维度——界面长什么样、用户怎么操作、功能用了什么技术。三者齐备,一个功能的描述才算完整。
截图必须取自实际运行的软件,不能用原型图或设计稿。使用说明按“步骤一、步骤二、步骤三”编号写,每步描述一个用户操作动作。技术栈写在功能项底部,用两三行说明该功能涉及的技术。
以登录功能为例,模板的结构可以这样填充:
### 3.1 系统登录功能说明 界面截图:(此处插入登录页面截图) 使用说明: 步骤一、打开系统首页,进入登录页面。 步骤二、输入账号和密码。 步骤三、点击登录按钮,系统校验通过后进入主界面。 技术栈:账号密码登录,密码加密存储,Token 认证。这段填充逻辑的关键在于:每个步骤对应一个用户能实际完成的动作,技术栈里的每一项都能在后续章节找到解释,不要出现“步骤里没提技术栈却堆了一串名词”的情况。
3.2 系统登录功能说明:步骤粒度与异常处理的平衡
登录功能的说明看起来简单,但步骤粒度是常见失分点。太粗的写法是“输入账号密码登录”,太细的写法是“按下键盘输入用户名中每个字符”。我一般把握的标准是:用户能照着步骤完整操作一遍,且不产生疑问。
推荐的步骤是四步:步骤一,打开浏览器,输入系统地址,进入登录页面。步骤二,输入已注册的账号和密码。步骤三,点击登录按钮,系统校验账号密码,通过后进入主界面。步骤四,如果连续五次输错密码,账号锁定,联系管理员解锁。第四步不是模板里有的,但建议补上。这展示的不是功能,而是软件对异常情况的处理能力,审查员对这类细节印象不错。
技术栈部分按模板的提示写。使用 HTTPS 就写“数据传输采用 HTTPS 加密,防止账号密码传输过程被截获”;使用了 OAuth 2.0 写“支持 OAuth 2.0 协议接入第三方授权登录”。这两项是模板摘要里被明确提出来说明的技术点,也是审查中容易关注的地方,但如果你的软件没有使用这些技术,不要写。
3.3 系统注册功能说明:验证流程的顺序感
注册功能的步骤比登录多,需要体现顺序。模板的注册占位是空的,按模板格式补全如下:
步骤一,进入登录页面,点击“注册”按钮,跳转注册页。步骤二,填写用户名、手机号、邮箱和密码。步骤三,点击“获取验证码”,系统发送验证码到手机或邮箱。步骤四,输入验证码,点击注册按钮,系统验证验证码和账号信息后创建账号,页面跳回登录页。
这里要额外写一句注册成功后的账号状态,比如“新注册用户默认拥有普通用户角色,管理员角色由后台管理员分配”。一句话把权限模型说清楚,后续在权限管理功能章节就不用再重复背景内容了。
技术栈方面,注册功能常涉及三个点:前端表单组件和校验逻辑、后端账号唯一性校验、验证码服务的时效性。写法示例:“前端使用 Vue 表单组件完成输入校验,后端对手机号和邮箱做唯一性校验,验证码有效期两分钟,过期需重新获取。”具体情况以实际代码为准。
3.4 其他功能模块:按用户角色分组扩展
真实软件肯定不止登录和注册两个功能。扩展写法延续“截图+步骤+技术栈”的结构,按用户角色或业务场景组织。一个带后台管理的系统,建议先写前台用户功能,再写后台管理员功能。前台功能里把登录、注册、个人中心、消息通知归为一组;后台功能里把用户管理、角色权限、数据报表归为另一组。
功能复杂度高的模块,步骤描述里要补充业务规则。以库存管理系统的出库操作为例:步骤一,选择出库单或新建出库单;步骤二,添加出库商品和数量;步骤三,系统校验库存数量,库存不足时页面提示;步骤四,确认出库,库存数量扣减。业务规则进了说明书,审查员对软件的理解就不停留在“填表”层面,而是能看到完整的业务闭环。
辅助功能可以简要带过,每个半页以内。对于运行中可能出现的异常提示,比如网络超时、数据库连接失败、验证码过期,建议用一张表格列出错误场景、页面提示内容和用户操作,对应说明书中的异常处理部分,也方便用户遇到问题时自行排查。
4. 技术栈与运行环境:把创新性合理地写出来
4.1 技术栈分四层描述:前端、后端、数据库、部署
模板的“技术栈:”字段只有一行,实际撰写时建议拆成四层写:前端框架、后端框架、数据库、运行环境。每一层用一两句话说明,比罗列一个长名词列表清晰得多。
前端:“系统前端使用 Vue.js 构建,UI 组件库采用 Element Plus,页面通过前端路由切换。”后端:“系统后端基于 Spring Boot 开发,以 RESTful API 形式对外提供接口。”数据库:“系统使用 MySQL 存储业务数据,使用 Redis 缓存登录会话。”部署:“系统部署在 Linux 服务器上,使用 Nginx 作为反向代理,应用以 Docker 容器方式运行。”
每层写不写,取决于软件是否真实使用。如果软件是单机版,没有数据库和部署层,就写“本系统为单机运行,数据存储在本地数据库文件中”。技术栈诚实,整份说明书才有可信度。
4.2 技术特征与功能描述要前后呼应
软著审查对软件“创新性”的判断,不是看技术栈里名词的先进程度,而是看技术特征有没有在功能描述里体现出来。所以技术栈和功能章节之间要保持呼应。
例如技术栈里写了“系统使用 JWT 令牌进行身份认证”,那么登录功能的技术栈字段里要提到 JWT,权限管理功能中也要有“访问受限页面时系统校验令牌有效性,失效则提示重新登录”的流程描述。这个前后呼应不是文字重复,而是让同一个技术特征在不同功能场景里都有落点,说明它确实被用起来了。
反之,功能章节里完全没有出现过的技术,别往技术栈里加。比如软件没有使用消息队列,功能描述里也没有任何异步处理的场景,却写了“使用 RabbitMQ 处理消息”,审查员对照源码后会产生整体不信任感,损失远大于收益。
4.3 截图与标注的规范操作
截图建议用浏览器无痕模式打开软件页面再截,避免书签栏、浏览器扩展图标出现在画面里。操作系统显示缩放比例固定为 100%。完整截取功能页面,包括查询条件、数据表格、分页控件,不要只截局部。需要圈出重点区域时,用红色方框标注并在图注里说明。
截图统一以 PNG 格式插入文档,不要在文档里二次拉伸缩放。如果原始截图包含敏感数据(比如真实用户手机号),在测试环境用测试数据跑一遍再截图,不要对真实数据界面直接截图。这个细节虽然和审查要求没有直接关系,但能避免数据隐私的连带问题。
4.4 运行环境表与安装部署说明
说明书里建议放一张运行环境表,四列内容:环境项、最低配置、推荐配置、说明。操作系统、数据库、浏览器、分辨率是常规行。表格信息必须与技术栈一致,比如数据库写了 MySQL,运行环境表就不能写 SQL Server。
安装部署部分写实际可行的方式。Web 系统写“以 Docker 镜像分发,启动后默认端口 8080,通过 Nginx 反向代理访问”。有安装包的系统写安装流程概览。不要写没有验证过的部署步骤,说明书里出现一条不准确的部署命令,比不写还要糟糕。审查员会拿说明书的运行环境配置去核对申请材料中的信息,一致性是软著材料审核的底层逻辑。
5. 软著说明书常见问题排查:五个退件场景与对策
5.1 截图模糊、被拉伸、带水印
现象:补正意见写着“界面截图不清晰,请重新截图”。放大后文字边缘发虚,界面上有“试用版”“未注册”水印,或者截图是从宣传物料里截下来的示意图。
原因:截图之后对图片做了拉伸放大。有人直接用手机对准屏幕拍照,再插进文档,这种截图的清晰度完全达不到要求。
解决:在软件真实运行环境中直接截图,界面多大就截多大,不要截小图再放大。截图前把操作系统缩放比调到 100%,关闭不需要的窗口。保存为 PNG 格式插入,之后不要调整图片大小。从界面本身出发重新截图,是唯一靠得住的方案。
5.2 功能描述与源码不一致
现象:说明书里写了“支持手机号验证码登录”,源码里只实现了账号密码登录;或者说明书的操作流程与代码逻辑顺序对不上。
原因:说明书由不熟悉代码细节的同事撰写,参考的是产品需求文档而不是实际实现。需求文档里规划过的功能开发时砍掉了,说明书却原样保留。
解决:提交前把说明书的功能清单和源码模块清单做一次一一对应。我习惯把一个简单的对应表列出来,左边是说明书章节,右边是源码中的主要文件或功能类名,核对完表格留在本地。如果有说明书写了但源码里找不到实现的功能,直接删掉说明书写法,翻译成源码里真实存在的功能描述。
5.3 著作人信息与申请主体不一致
现象:封面著作人写个人姓名,申请表是企业申请;或者封面软件名称与申请表名称有细微差异,比如多了一个“管理”两个字。
原因:多人协作填写材料,每个人负责一部分,最后合并时没有做交叉核对。模板中的“著作人:企业名称或姓名”占了位,忘记替换成实际主体。
解决:提交前把申请表、说明书封面、源码文档首页放在同一屏里,核对软件全称、版本号、著作人三项。企业申请写企业全称,个人申请写个人姓名,不用简称、花名、团队名。这三项一致是所有软著材料审核的第一关,守住这一关至少能省掉一次补正周期。
5.4 说明书页数过多或过少
现象:整份说明书只有七八页,功能介绍每一块只有两三行;或者写了七八十页,每个输入框都单列一个功能章节。两种极端都可能被退回要求调整。
原因:前者没有把界面交互和业务规则写进去,后者功能粒度拆分过细,把“输入框自动聚焦”这种界面细节当成一个功能来写。
解决:按模板的三段式结构控制粒度,登录、注册这类基础功能 1 到 2 页。功能少的小软件,通过补充交互说明、异常处理说明把内容做实。功能多的大软件,把同类型的操作合并成功能组,比如“列表查询”“详情查看”“导出数据”合并成“数据管理功能组”,以组为粒度展开。
5.5 技术栈堆砌与实际技术脱节
现象:技术栈写了二十个名词,几乎涵盖了主流后端中间件的全家桶,但功能描述基本是基础的增删改查。审查员一旦形成“技术栈与功能不符”的印象,整份说明书的可信度都会受影响。
原因:技术栈直接照搬了招聘 JD 或同类产品方案,没有对照自己软件的真实开发技术选型。
解决:技术栈只写实际使用的技术。每一条技术栈尽量关联到一个具体功能,并在功能章节能找到对应的描述。比如写了 HTTPS,登录描述中就能看到“HTTPS 加密传输”;写了 Redis,数据缓存相关功能里就该出现缓存更新逻辑。技术与功能一一对应,说明书整体的说服力会有本质提升。
6. 提交前最后十分钟:三个检查习惯
6.1 通读一遍 PDF,只看功能描述
说明书导出 PDF 后,按页翻一遍。重点看功能模块的“使用说明”部分,把每一段当作给一个完全没接触过软件的人写的说明来读。如果某一步要靠猜才能接上,就把那一步补完整。通读不需要改格式,只需要标记文字上说不通的地方。
6.2 三项信息三处一致的核对
把申请表、说明书封面、源码文档首页放在一起,逐项看软件全称、版本号、著作人。这三处是审查员最先对比的信息,任何一处不一致都会直接触发补正。两分钟能完成的事,不要用补正的几天时间来换。
6.3 截图逐页复核
翻 PDF 时顺手检查每一张截图:界面是否干净,有没有水印和浏览器插件图标;截图数据日期与当前版本是否匹配;图注编号是否连续且有对应的正文引用。截图里的数据展示的是几个月前的旧界面,审查员无法通过截图看到当前版本的实际表现,所以提交前最好重新截一遍关键页面。
我自己吃过一次亏:提交前改掉了登录页的按钮文案,却忘了更新说明书里的登录截图,退件意见明确指向“界面截图与软件实际界面不符”。从那以后,我每次提交软著材料的前一天都会强制走一遍截图复核流程,从第一页翻到最后一页,把截图和当前运行版本逐张对比。这个习惯花不了十分钟,但能让一次通过的概率明显提高。希望帮到你。
本文还有配套的精品资源,点击获取