#今天也是咸鱼的一天~
手把手教你申请计算机软件著作权系列
申请计算机软件著作权(以下简称“软著”),一共要提交四份文件:身份证明,设计代码,申请表,软件使用(设计)说明文档。
前三个已经介绍过了,所以这篇博客就来讲如何
撰写软件使用说明书
。
——————————————————————————————————————————
因为博客作者本身就是大学生,针对的对象也是申请软著的大学生,有些内容会和公司方申请不太一样,同时某些细节不太详细,为避免您的申请错误,请不要参考太多文章内容,以防带来损失。
——————————————————————————————————————————
撰写软件使用说明书
软件使用(设计)说明书介绍
划重点:
对于嵌入式软件、硬件代码、数据库代码,这类没有图形操作界面的软件代码,写的就不是“软件使用说明书”,而是软件设计说明书。对于代码的设计思路需要一个较为详细的阐述。
对于有操作界面的软件,如Windows窗体应用程序、安卓应用程序、苹果应用程序,写的就是“软件使用说明书”。重点在于使用的说明和讲解上,有点偏向于用户手册的格式。
对于大学生可能比较少申请的操作系统软件、编译器代码,这类就是要包含使用和设计两大部分,因为这个是一个复杂的软件系统,需要一个详细的阐述。
——————
软件使用说明书,是一个用来描述程序的内容,组成、设计、功能规格、开发情况、测试结果及使用方法的说明文档,如程序设计说明书、流程图、用户手册等。
在提交上,如果说明文档没有超过60页,则全部提交;如果超过了60页,则提交前30页和后30页。
在大部分软著申请的补正提交材料上,都是申请表和软件说明文档出的问题,所以务必好好注意软件说明文档的撰写。
说明书基本要求
- 语言:自然语言,尽量通俗易懂,少用术语。
- 页面格式:有页眉、版本号、软件名称、页码。(名称和版本号要和申请表完全一致)
- 行数:一页不少于30行,有图除外。
- 如果文档内容过多,请写目录。(我等大学生大部分不会有这个问题)
- 可以根据情况,适当添加软件代码编程环境的安装过程。(你品,你细品)
- 软件界面的截屏,一定要截全屏。(不然会被打回,看命)
- 对于硬件,有显示屏的,可以加显示屏显示信息的图片。或者,利用串口上位机进行数据显示的,可以截上位机的图,来帮助软件代码功能说明。
- 写明软件运行环境,以方便用户准确匹配设备。
- 图文结合,但图片不能太多,要显得自然一点。
- 有详细的操作流程,详细到手把手的那种。
- 图片不能含有马赛克、横杠等覆盖截图内容信息的遮挡物。要求图片打印后清晰
心得体会
-
思路一定要清晰,解释一定要详细。有公式的,一定要把公式列出来,再做一个解说。 对于有界面的,一定要把每一个功能都解释到位了,就当做教小白用这个,从0开始的那种。对于有调用库函数的,还要一并把这个库函数的功能介绍一轮,要是有原理,原理也要解释。
总之就是越详细越好。 - 关于是否要把写代码的IDE或者EDA的安装流程写出来,这个可写可不写,写了锦上添花,不写没有太大问题。
- 如果写的软件要有安装过程,务必要把这个安装流程详细阐述一遍,每一个过程都要截图。
-
把握层次,在描述的时候,要写出一种层层递进的感觉。
比如:
首先,这样,然后,其次,在,于是,有了,出现了,最终。
关于这个,是这样,带来结果,产生影响,出现什么。
使用了什么,实现了一个,展现了效果,使…… - 不要出现太口语化的内容,在用自然语言的基础上,描述的尽量严谨,避免出现语义的错误。
- 尽量避免出现人称,第一第二第三人称都尽量少出现,尤其是我,我们,你这样开头的语句。使用像用户,使用者,操作者,工程师,管理员这样的带有形容使用软件特性的人的名词比较好。(有点拗口,但就是这么个意思)
- 注意字体的使用。
- 图片的大小尽量一致,保证美观和避免人家万一就因为这个给你打回来不交,就惨了。
————————————————————写完的分割线————————————————————
不同人对于软件说明书的撰写内容也不一样,所以这里也不放图来误导人了,大家随便上网都能找到很多模板,照着写一份就OK了。
主要还是注意官网的要求,避免少走弯路,比竟如果写错了,补寄材料也挺麻烦的。
网上有一个要求说,6000行以下代码,说明书至少5页,6000行以上的,至少15页。不确定这个到底对不对,请读者自行查证。
博客所写内容,均为本人自己经历,不保证内容100%正确,如有错误,请指正,不胜感激。