资源预览内容
亲,该文档总共2页全部预览完了,如果喜欢就下载吧!
资源描述
软件文档编写全攻略 模板五要素 对于一个产品来说,除了设计文档、 开发文档, 还要有随着安装包发售给最终用户额安 装手册、使用手册、联机帮助等。要编写一份图文并茂、格式优雅的文档,是要些功夫的。 未了节省文档的编写时间以及保证不同文档的统一风格,我们首先要编写一个word 模板文 件、并在每份文档中都应用这个模板。 一个 word 模板应该包括如下一些要素: 1标题的风格 文章的各级标题使用的字体字号,一般要包含对三层标题的风格描述,以便我们在文档 完成之后可以插入包含三层标题信息的索引和目录。 2表格的风格 设定表格的边框、底纹、字体、颜色、字号,以及表格说明文字的字体字号等。 3图像的风格 对图像的显示位置(居左、居中、居右),以及图像说明文字的字体字号等作设定。 4正文的风格 包括正文内容的字体、字号等。 5页眉页脚的风格 设定页眉处是否添加当前章节标题,页码的位置与样式等。 确定好文档模板,或则说确定好了一篇文档的版式风格以后,就要开始充实文档的内 容了。对于开发人员来说,为自己coding 出来的软件产品编写使用手册、安装手册、联机 帮助等是一件包含有复杂感情的事。一方面,程序员对自己产品的理解肯定事最为透彻的, 写出来的内容也最丰富而全面,最具有权威性; 另一方面, 大概所有的程序员都会认为写文 档实在是一件无比乏味的事情,况且,写出来的东西还要经过测试部门近乎苛刻的检查把关, 反复修改。 不过,对于任何人来说,如果能够在做事情的时候不断开创性地寻找事半功倍的解决之 道,一件本来很无聊的事情也会做得有滋有味乐趣无穷。这种开创性, 不一定非得是发明一 些新事务,也包括能把一些已有的事物巧妙的组合起来为已所用。 制作屏幕截图 对于需要图文并茂的正式文档来说,一个很繁琐的工作就是截图。这里介绍一款非常 强大易用的屏幕截图软件:SNAGIT 使用 snagit 的基本捕获功能,我们可以轻松的截取屏幕上的对话框、菜单条、工具条、 编辑框等大大小小的对象。使用其“带延时选项的菜单”功能,配合“捕获设置” 里面的“输 入”设置,则可以方便的截取诸如下拉菜单、鼠标右键菜单等。非常方便的是,snagit 可以 直接定位截获到我们需要的局部图片,很少需要再加工,节约很多时间。 Snagit 提供了强大的图像编辑功能,除了基本的线条、箭头、文字等功能,snagit 还提 供了置换、色调、饱和度、对比度等颜色方面的调整方法,还有水印、浮雕、锐化、马赛克 等特殊效果处理等等。 Snagit 还提供了录制屏幕视频等功能,不过使用后感觉效果不是很理想。 Snagit 可以把屏幕截取的结果输出到不同的目的地:打印机、文件、剪贴板、邮件、网 络等等。 制作 chm 文件 再 snagit 和 word 模板的帮助下,我们可以很快的编写完一个产品手册了,如果还需要 对产品编写一个chm 格式的联机帮助,就要做更多工作。 目前制作chm 比较好的工具有quick chm 和 visual chm,使用这两款工具我们都不需 要做很多工作,就可以轻松的把html 文件编译导入工程中并编译成CHM 文件。 Quick CHM 是中国人的产品,与国外产品相比毫不逊色。它提供了很强大的HTML编 辑功能,可以完全用它来完成所有HTML页面的制作,无需借助与其他网页制作工具如 FRONTPAGE 、 DREAM WEA VER 等。 Quick CHM 提供了 3 种不同语言的界面, 编译后 CHM 可以选择上百种不同的语言。 Visual chm 提供了 14 种不同语言的界面,编译后的CHM 也可以选择上百种不同的语 言。 它没有 HTML 页面编辑功能, 我们必须借助于其他工具来制作,再导入进来编译除CHM 文件。 使用 MICROSOFT WORD 把 doc 文档“另存为”html 格式,再把HTML结果文件导 入 QUICK CHM编译,是行不同的,会陷入死循环。现在介绍一种可行的方法。 安装一个DREAM WEA VER 2004 , 打开 word 文件,选中word 文件的内容,直接粘贴 到 DREAM WEA VER 2004 的 html 页面中,可以很好的保存原有的格式,并且可以把图片、 表格很好的保存下来。测试发现,如果是在DREAM WEA VER MX中,只能粘贴文本,无 法很好的保留word 文件的版式内容。 主域,如果从 word 中复制内容到DREAM WEA VER 的 html 页面时,DREAM WEA VER 2000 报告类似于“复制的文档太大”,请复制word 中的一部分内容,然后新建一个word 文件夹并粘贴进来,然后在从这个文件中复制并粘贴到DREAM WEAVER 2004 的 html 页 面中。 使用从 word 中直接复制内容到dream weaver的方法, 我们可以很方便的得到所需要的 html 页面。 使用 quick chm ,我们遵循下面的步骤来创建一个chm 工程: 一、运行 quick chm 启动 quick chm 后,我们通过菜单项【文件】【chm 向导】来利用chm 向导创建一 个工程。 二、使用 chm 向导创建工程 设定工程的存储路径和名称,将从指定的路径下收集html 文件。在这一步中,我们要 为工程指定名称,指定项目的html 文件存储路径。 三、检查 html 列表 四、设定主题的读取位置 这里要设置chm 文件的目录中显示的内容从哪里提取,一般情况下设定为“读取网页 标题” ,这就要求我们在前面制作html 文件时,预先把html 的 title 值设置好。另外,在本 页中根据实际需要设置是否“有目录”或“有索引”。一般情况下都保留。 五、完成向导 完成向导之后,我们可以检查左侧的“目录”和“索引”中内容是否仍然存在问题, 如果有问题,我们可以继续使用中间的工具条来调整。 六、编译成 CHM 确认所有信息无误后,我们就可以点击工具栏上的图标来进行编译。编译结果时, 会提示我们已经成功编译生成CHM 文件,是否要立即运行。至此,一份精美的CHM 联机 帮助就制作出来了。
网站客服QQ:2055934822
金锄头文库版权所有
经营许可证:蜀ICP备13022795号 | 川公网安备 51140202000112号