用模板的正确姿势是：先按真实代码列功能清单，再套模板填内容，最后逐条回查代码。顺序反了就会写成一份看着完整、实际对不上代码的文档，这是补正里最常见的一类问题。
一份说明书通常包含什么
软件文档可以是操作说明书、设计说明书或用户手册，结构大同小异，常见章节包括：软件概述、运行环境、功能模块说明、操作流程、界面说明、异常处理。章节数量不必多，关键是覆盖主要功能。
软件概述
一段话讲清这个软件做什么、给谁用、解决什么问题。不要写成市场宣传语，写功能定位。名称和版本号在这里出现时，必须和申请表、页眉完全一致。
运行环境
写清运行所需的软硬件条件，比如操作系统、浏览器、运行框架、数据库。小程序或插件类要说明它依附的平台，这一条经常被忽略。
功能模块怎么写才和代码对得上
按代码里的实际结构来组织。如果代码里是用户管理、权限管理、数据统计三个模块，文档里的章节就按这三块展开，不要额外加一个代码里没有的智能分析。
- 每个模块写清作用、入口、主要操作；
- 模块名称尽量与代码里的类名或目录名可对应；
- 核心功能配一到两张真实截图；
- 涉及权限差异的，说明不同角色看到的内容。
页数与格式要求
软件文档常见要求是前、后各连续 30 页，不足 60 页全部提交。每页要有页眉，写明软件全称和版本号，页码连续。排版上保持字号行距统一，截图清晰可辨，不要出现大段空白凑页数。
| 检查项 | 标准 | 不合格的典型表现 |
|---|---|---|
| 名称版本 | 与申请表、源程序页眉一致 | 封面写简称，页眉写全称 |
| 功能覆盖 | 覆盖主要模块，与代码对应 | 写了代码里没有的功能 |
| 截图 | 本软件真实运行界面 | 用原型图或别的产品截图 |
| 页眉页码 | 每页齐全，编号连续 | 中间几页漏页眉 |
| 页数 | 前后各 30 页，不足全交 | 靠空白页凑数 |
写完必做的五项自查
- 全文搜索软件名称，确认每一处写法一致，没有简称混用。判断标准是搜索结果里没有两个不同写法。
- 逐条对照功能清单，确认每个功能在代码里有对应实现，删掉所有找不到落点的描述。容易出错的地方是模板自带的示例功能忘了删。
- 检查截图日期和界面，确认与当前版本一致，避免出现旧版本界面。
- 确认页眉页码齐全，导出 PDF 后随机翻几页看页眉有没有丢。
- 和申请表核对日期与主体信息，文档里如果提到权利人或日期，要和申请表一致。
模板最大的作用是保证结构完整，最大的风险是诱导你写进模板自带的示例内容。所以套完模板一定要做一次删减，把不属于这个软件的东西全部去掉。用软著说明书生成工具可以先按功能清单生成初稿，再由你逐条修剪，比从空白文档开始快。软著Pro 提供的就是这套流程，网址是 https://ruanzhu.pro。
常见问题
说明书可以用设计文档代替吗
可以。操作说明书、设计说明书、用户手册都常见，关键是能体现软件功能与实现。
篇幅是不是越长越好
不是。页数满足要求即可，内容准确比篇幅重要，堆无意义内容反而增加不一致的风险。
截图必须是自己软件的吗
必须是。用别的产品或原型图替代属于材料不实，很容易被发现。
模板里的示例功能要删吗
要删。留着会形成文档里有、代码里没有的功能，直接导致补正。
一个软件多语言版本要分别写吗
通常合在一份文档里说明即可，除非是多端独立产品，才考虑分开申请。
说明书和源程序页数必须一样吗
不必一样，两套材料各自满足页数要求即可，但页眉里的名称版本必须一致。
文档格式要求以办理时中国版权保护中心的规定为准。
