夜雨聆风学习资料网

ARTICLE · 1400064

软著材料写了好几份,我把模板和工具开源了

软著材料写了好几份,我把模板和工具开源了

最近整理了几份科研软件的著作权申请材料。模板、脚本和检查清单每次都在重写,索性把LaTeX模板、源代码排版工具和写作指南收进一个仓库:software-copyright-kit。

GitHub:https://github.com/gxf1212/software-copyright-kit

写完软件,还要花不少时间整理材料

写代码这件事做过很多遍,卡住的是材料:申请表、软件说明书和源程序文档。

我之前陆续整理过几份软著,涉及命令行程序、分子模拟工具和带图形界面的软件。说明书要写哪几章、每章写到什么程度,每次都得重新想一遍。

比如,说明书应该有哪些章节?功能介绍写多详细合适?命令行软件要怎么介绍参数、输入输出,界面型软件又该怎么组织操作步骤和截图?

源程序文档也很麻烦。需要从真实源码整理代码清单,统一页眉、页码、字体、行距,再检查每页行数,按交存要求截取相应页面。对于代码量较大的项目,手动整理尤其费事。

还有一些细节,往往要到最后核对才发现:申请表和说明书的软件名称不一致,功能介绍写了代码里不存在的选项,截图上的界面和当前程序不完全相同,或者代码排版后出现大量空白页。

几轮改下来,模板和脚本基本定型。下次写软著,复制一份改就行,课题组里其他同学也能照着用。

software-copyright-kit:从源码到申请材料

项目地址:https://github.com/gxf1212/software-copyright-kit

这个仓库主要覆盖软著申请中的材料编写、排版和提交前检查。它包含一份可以直接编译的示例工程,以及改造成其他软件所需的模板、工具和写作指南。

1. 可以直接参考的说明书模板

说明书采用XeLaTeX排版,基于easybook模板修改,目前提供6个章节:引言、安装配置、命令行使用方法、图形界面使用方法、数据结构及附录。软件架构和功能模块说明放在引言中。

其中,命令行和图形界面是独立章节,可以根据软件类型选择。对于科研中常见的计算程序,重点介绍命令参数、输入文件、运行过程和结果;对于界面型软件,则结合真实截图说明操作步骤。

每章的.tex文件开头还保留了写作提示,说明这一章应该介绍什么、哪些内容可以省略,以及如何组织示例。

下面是实际编译出的说明书内页。代码块、参数说明、表格和正文已经设置好样式,可以直接替换内容。

图形界面那章放了一张浏览器界面截图,图注和正文引用都写全了,换上自己的截图即可。

2. 源程序文档也准备好了

源程序文档使用独立的LaTeX样式,保留代码语法高亮,采用纯白底、无边框的排版。

用户只需整理需要展示的源代码文件,在code_simplified.tex中指定对应路径,便可生成带软件名称和页码的代码文档。

仓库还提供了代码副本生成、行数统计、PDF抽页等脚本,可以辅助完成源程序整理。原始源码与排版副本分开管理:前者保留在src/,后者放在src_prod/。

仓库中已经附带两份完整的示例PDF,下载后可以直接查看实际效果。

示例软件是一个简单的CSV数据整理工具DemoTool,包含命令行和Streamlit网页两种入口。选这个小项目,是因为代码、操作方式和最终文档能对上,照着走一遍就知道模板怎么用。课题组内的同学,可以联系我获取真实的几个用户手册文档。

3. 申请表和检查流程

申请表采用Markdown格式的application.md,列出了软件基本信息、开发目的、主要功能、技术特点、运行环境等栏目,以及相应的填写要求。

另外还保留了一个facts.md事实清单,用来记录软件功能、命令入口、重要参数和关键数字,并注明对应的源码依据。

这个文件来自我之前整理科研软件材料时遇到的问题:同一个项目中,数据总量、筛选后的数量、预测候选数量可能各不相同。如果没有统一记录,写完几十页说明书后再核对,很容易发现前后用词或数字不一致。

工具包也提供了PDF行数检查、材料一致性审查、隐私信息检查和版本记录等脚本。这些工具可以帮忙发现一部分常见错误,最后仍需人工通读确认。

排版和检查之外,交存规则也写进了指南:说明书和源程序一般各取前、后连续的30页,总量不足60页就全部提交;源程序每页不少于50行,文档每页不少于30行。这些数字以登记机构的现行要求为准,提交前仍需核对。

配套的脚本把这两条规则落到工具上:extract_front_back_pages.py自动跳过封面和目录、从正文第1页起算前30页;check_pdf_lines.py按排版后的实际行数统计,用来发现留白过多的稀疏页。

4. softcopy-toolkit:把上面这些步骤做成命令

前面提到的编译、统计、抽页和检查脚本,统一放在softcopy-toolkit/目录,来自实际软著项目,可以在多个软著包之间复用。按用途可以分成几组:

•编译与排版:compile.sh用XeLaTeX编译说明书或源程序文档,按文件名自动套用30行或50行的检查规则,编译失败会返回非零状态,不会把旧PDF误报成成功。

•源码整理:init_code_copy.py从src/生成去掉空行的src_prod/副本,count_lines.py统计源码行数;带--remove-empty时会就地改写文件,因此只允许在src_prod/这类生成副本上运行。

•交存与验收:除上面的抽页和行数脚本外,search_pdf_text.py在PDF文本层检索关键词,方便定位某段内容落在哪一页。

•提交前审计:audit_material.py核对软件命名一致性、待填占位符和代码引用,check_privacy.py扫描个人信息、邮箱和本地路径,freeze_version.py记录源码提交号、版本和PDF哈希,便于日后复现这一版材料。

•辅助工具:convert_quotes.py把Markdown里的英文双引号换成中文引号,serve_docs.py起一个本地页面查看生成的两份PDF。

这些脚本大多只依赖标准库,少数需要pypdf、pymupdf等,依赖和完整命令写在softcopy-toolkit/README.md里。工具解决的是重复劳动,材料写得准不准仍要自己确认。

也可以交给AI协助整理

仓库提供了CLAUDE.md和AGENTS.md,分别作为Claude Code、Codex等AI编程助手的工作入口;guidelines/目录中还有分阶段的写作指南。

使用时,可以把自己的软件源码路径提供给AI,让它先阅读项目代码,整理真实功能、参数、输入输出和模块关系,再按照模板编写说明书、组织代码清单和填写申请表草稿。

我在指南中特别加入了几项检查要求:文档中提到的命令需要与真实代码对应;介绍模型的软件要区分训练、交叉验证和预测;网页展示历史结果或训练日志时,也要准确描述其实际功能。

这些内容来自之前反复修改软著材料的经历。说明书写得漂亮没用,每一句话都得能在代码里找到对应。

AI可以帮助阅读源码、组织文字和排版,但生成的内容仍需要开发者逐项核实。仓库也保留了手动编写的路径,完全可以不借助AI使用。

有一点是2026年起才要注意的:版权保护中心的新版申请表印有独立开发、未使用AI参与代码与材料撰写的声明。这套AI流程适合读源码、梳理功能和生成草稿,提交前请对照实际情况确认怎么填,不要签与事实不符的声明。

怎么开始使用?

如果只想了解最终材料的样式,直接打开仓库中的两份PDF即可。

准备为自己的软件制作材料时,可以先克隆仓库:

git clone https://github.com/gxf1212/software-copyright-kit.git
cd software-copyright-kit

建议先花几分钟看一下guidelines/目录,再动手改模板。那里是整套材料的写作规范,不管用不用AI都适用:

•01-handbook-guide.md:说明书各章写什么、引言里怎么讲软件架构。

•02-source-code-guide.md:源码副本怎么准备、源程序文档怎么排版和验收。

•03-application-guide.md:申请表怎么填,包括字数限制和命名一致性。

•04-review-guide.md:提交前怎么和真实源码核对、去AI味、检查版面。

•writing-style.md:中文写作规范,软著、论文、推文都能用。

•author-philosophy.md:总原则,像写程序包手册一样写,需求导向、尽量精简。

自己写时,可以把每份指南当作对应阶段的检查清单;用AI时,把指南文件连同真实软件信息一起交给它即可。

手动使用时,主要修改software_copyright/中的配置文件和各章节内容,再放入自己的源码,按README中的命令生成PDF。编译需要XeLaTeX及相应的中文字体环境。

如果使用Claude Code或Codex,可以先让它阅读仓库根目录的CLAUDE.md或AGENTS.md,再提供需要整理的真实软件目录。AI会按照指南逐步分析和准备材料。

这个项目适合已经完成软件开发、需要整理软著材料的研究生、科研人员和独立开发者。无论是命令行程序、图形界面工具,还是有较复杂计算流程的科研软件,都可以参考现有模板调整章节。

工具包只负责辅助准备和检查材料,不包含登记申请、审批或证书办理功能,也无法保证材料一定通过审查。实际提交时,软件权属、开发信息、AI使用情况及交存格式仍需根据登记机构的现行要求核实。

最后

这套模板最初只是自己写软著时积累的一些.tex文件和小脚本,后来补齐了写作指南、示例程序、检查工具和完整PDF。下次写软著,复制一份改就行,不用再从头排版。有问题可以提issue。

GitHub开源地址:https://github.com/gxf1212/software-copyright-kit

仓库采用MIT许可证,自带的第三方LaTeX模板遵循其原有许可证。

回首页,搜索你想要的文档

在首页搜索框输入关键词,快速定位资料

文库首页搜索指引 立即搜索

相关学习资料