教程编写基本要求
作者:admin来源:部落窝 发布时间:2016-07-01 18:00:04 点击:16685
一、 标题
1. 标题最多划分6级标题,一般划分3~4级就够了。
2. 格式。
标题的参考格式:
3. 标题格式要统一,同一级标题的字体、字号、间距等都要一致。
二、 正文
1. 正文主要采用5号宋体,最小可以采用9.5磅宋体。行距采用1.0。
2. 段首空两个字符;段与段之间不用空行。
3. 段中的提示、注意、技巧等一律当做有变化的正文处理。将其独立成段,然后用不同于正文的字体、字号、底色即可。
三、 截图
1. 截图应尽量统一大小和比例,兼顾版面的美观,不要在同一页的图大的很大,小的很小。但并非所有图都必须尺寸一样。
2. 截图应当编制图题,尤其是图多的时候,便于读者分辨各个图。图题就是图的标题,如下。
图1 俯拍花朵
3. 截图注释。
为截图添加文字注释需要注意以下要求。
(1)文字大小、字体要统一。不能忽大忽小,不适合采用多种字体。
(2)多个注释排列要整齐。
(3)请尽量用word编辑注释,而不要用截图软件等编辑注释。
图2 截图注释
四、 表格
1. 表格格式要统一,同样需要编辑表题,如下。
表1:图层类别
2. 表的外框线一般用粗线,内线用细实线;表格左右两侧的外框线可以不画。
3. 表中文字句末不加标点。
五、 叙述约定
1. 鼠标操作叙述。
(1)按一下鼠标左键:用“单击鼠标”,不用“点击鼠标”等。
(2)按一下鼠标右键:用“右击鼠标”,不用“单击鼠标右键”等。
(3)连续按两下鼠标左键:用“双击鼠标”,不用“连续点击两次鼠标”等。
(4)按下鼠标左键同时移动鼠标:用“拖动鼠标”,不用“按下鼠标左键移动”等。
2. 命令叙述。
(1)可以说成“单击某命令”,也可以说“选择某命令”“执行某命令”,但整篇教程的说法要统一。
(2)级联菜单命令表述为:“文件”/“保存”或者“文件/保存”,也可以“文件→保存”。但同样整篇教程需要统一。
3. 工具叙述。
可以说成“单击某工具”,也可以说“选择某工具”。整篇教程的说法要统一。
4. 对话框各组成的叙述。
常见的对话框各组成如图3。
图3 对话框组成
对对话框的叙述例举如下:
①在弹出的“选项”对话框中,单击“视图”标签切换至“视图”选项卡,勾选“格式标记”选项组中“段落标记”选项前的复选框,然后单击“确定”按钮完成设置。
②单击“word选项”对话框左侧选项框中的“保存”选项,在“文档管理服务器文件的脱机编辑选项”选项组中单击“office文档缓存”单选按钮,并在“服务器草稿位置”文本框中设置草稿保存路径;单击“共享该文档时保留保真度”下拉按钮,从弹出的下拉列表中选择“编辑部书稿编写要求”选项。
1. 按键叙述。
(1)键名必须与键盘上严格一致,包括大小写在内。
(2)键名不需要添加任何标点符号,直接书写, 如不用“按‘F2’键”而直接写成“按F2键”。
(3)快捷键的叙述,先说按键,后说功能:如“按Ctrl+A全选”。
六、 案例操作步骤
(1)步骤编号统一采用(1)(2)(3)等编号格式。
(2)步骤的叙述应当明确、直白、可操作。也就是所写步骤必须让既定的读者群大多数读者都能明白并参照执行。
(3)步骤中的对话框、属性栏的设置项目适宜用线框指示出来,如图4。
图4 指出参数设置
七、 教程版权信息处理
1. 汇编教程版权信息处理
汇编教程可以说就是转载教程,为了尊重原作者,为了不违反知识产权相关法规,汇编教程必须注明原文名称、出处、作者。
注明位置和格式:
位置:一律在教程最末进行注明。
格式:
原文:某某某某(文章名称)
作(译)者:某某某(著),某某某(译)
出处:www.xxxx.xxx(网址或网站名称)
外文原版出处:www.xxxx.xxx(网址或网站名称)
2. 原创教程版权信息处理
原创教程的版权将严格审核。作为原创教程,作者必须对自己提交的教程负责,确保不违法国家知识产权等相关法律法规。
1)署名位置和格式。
位置:一律在教程最前端注明署名。
格式:
署名及顺序:江小鱼 花千骨
2)合理引用注明。
如果稿件中引用了他人的文字、图片、音乐、视频等,需要在稿件中给予说明。说明的格式为:
某某(作者),作品名。
3)提交版权申明。
作者在提交稿件的同时需要提交版权申明文件。版权申明文件一律与稿件一并发到公司征稿邮箱中。
八、 视频录制1. 视频录制要求。
请参考部落窝提供的视频文件录制视频。
(1)声音清晰;
(2)有比较丰富的语调变化,具有抑扬顿挫的感觉;
(3)范例视频,要重分析,避免单纯的步骤录制;
(4)可以搭配音乐,但背景音乐只能使用已进入公有领域的音乐,并且背景音乐要尽量小,不能妨碍观众听讲;
(5)搭配适当的字幕;
(6)避免画面有超过50秒的“画面沉默”(画面没有任何变化)。
2. 视频格式和分辨率。
格式:MP4或FLV
分辨率:1280x720,推荐高清分辨率1920x1080。
九、 交稿要求
交稿最基本要求是齐、清、定。
齐:文档齐全。每篇教程都包括教程word文档、教程素材、教程范例源文件、教程视频、版权申明文档。
清:就是文档版面格式统一,标题清晰;各文档命名清晰,文件夹分类和命名得当;所有文件易看易查找。
定:就是文稿已经基本确定,作者不再进行大的调整、删改。