育才学习网1. 如何编写帮助文档
每个开发人员都知道改写原有的应用程序是一项多么艰苦的事情。
对先前开发小组思维模式进行逆向工程是对开发人员技术水平的真正测试。真正阻碍这一过程的一件事是没有相关文档可用，而且同时（原有）应用程序所涉及的开发人员全部不在。
所以，既然开发人员知道即使最基本的文档都能够成为很有用的工具，那么为什么我们常常会忽视这一项工作呢？我所认识的大多数开发人员都承认他们没有足够的时间来编写文档。但是，这项平凡的工作确实能够为你或者你的同事节省大量的开发时间。
如果你需要编写文档，那就看看本文的提示吧，你会知道帮助文档需要包含哪些内容，以及在哪些地方可以找到帮助完成这一任务的工具。描述应用程序的核心元素从一开始就概括应用程序的技术细节当然是非常的理想的。
简化这一过程的一种方式是首先抓住每个应用程序都有的四个核心元素：数据、业务规则、用户界面，以及安全。下面我就详细解释一下每个部分：数据：系统所使用的后端数据既可以简单到只有几个表格，也可以复杂到有数百个表格，甚至是存储过程、视图和其他等等。
当开发人员面对新的系统时，手里有最新的数据模型/图表就能够为他们节省大量的时间。 业务规则：目前，进行系统设计的方法是把业务规则放在设计人员自己（开发）的对象里，同数据和用户界面隔离开，但是这未必就是正确的。
一个概述系统业务规则的简单文档能够在很大程度上增强读者对应用程序的用途的理解。 用户界面：我认为用户界面是比较容易理解的应用程序特性之一，这主要是因为通过启动和使用应用程序你就可以对它有一个比较好的感受。
由于常常会使用自定义控件或者第三方的工具，所以理解起来会稍稍困难一些。为用户界面编写文档的一个好方法是提供系统所用的窗体和其它元素的列表及其详细说明。
安全：开发人员在给系统编写帮助文档的时候常常会忽视安全这一特性。当你查看原有代码的时候，你毫无疑问将注意到不同地方都设置了安全检查，但是要对应用程序的安全模型有一个整体上的认识是很困难的。
2. 如何编写帮助文档
每个开发人员都知道改写原有的应用程序是一项多么艰苦的事情。
对先前开发小组思维模式进行逆向工程是对开发人员技术水平的真正测试。真正阻碍这一过程的一件事是没有相关文档可用，而且同时（原有）应用程序所涉及的开发人员全部不在。
所以，既然开发人员知道即使最基本的文档都能够成为很有用的工具，那么为什么我们常常会忽视这一项工作呢？我所认识的大多数开发人员都承认他们没有足够的时间来编写文档。但是，这项平凡的工作确实能够为你或者你的同事节省大量的开发时间。
如果你需要编写文档，那就看看本文的提示吧，你会知道帮助文档需要包含哪些内容，以及在哪些地方可以找到帮助完成这一任务的工具。描述应用程序的核心元素从一开始就概括应用程序的技术细节当然是非常的理想的。
简化这一过程的一种方式是首先抓住每个应用程序都有的四个核心元素：数据、业务规则、用户界面，以及安全。下面我就详细解释一下每个部分：数据：系统所使用的后端数据既可以简单到只有几个表格，也可以复杂到有数百个表格，甚至是存储过程、视图和其他等等。
当开发人员面对新的系统时，手里有最新的数据模型/图表就能够为他们节省大量的时间。 业务规则：目前，进行系统设计的方法是把业务规则放在设计人员自己（开发）的对象里，同数据和用户界面隔离开，但是这未必就是正确的。
一个概述系统业务规则的简单文档能够在很大程度上增强读者对应用程序的用途的理解。 用户界面：我认为用户界面是比较容易理解的应用程序特性之一，这主要是因为通过启动和使用应用程序你就可以对它有一个比较好的感受。
由于常常会使用自定义控件或者第三方的工具，所以理解起来会稍稍困难一些。为用户界面编写文档的一个好方法是提供系统所用的窗体和其它元素的列表及其详细说明。
安全：开发人员在给系统编写帮助文档的时候常常会忽视安全这一特性。当你查看原有代码的时候，你毫无疑问将注意到不同地方都设置了安全检查，但是要对应用程序的安全模型有一个整体上的认识是很困难的。
3. 怎么制作帮助文档
使用QuickCHM软件轻松编译CHM格式的文件
谈起CHM格式的文件，可能无人不晓，因为几乎所有的软件，现在都用CHM格式的文档制作软件帮助文件。另外，有很大一部分电子图书也是用CHM格式编译的。其实，编译CHM格式的文件很简单，下面就为大家介绍一款制作CHM文件的利器——QuickCHM。
软件名称：QuickCHM
软件大小：1460KB
下载地址：
在介绍QuickCHM之前，有必要对CHM的格式作个简单说明。CHM文件格式是微软1998年推出的基于HTML的帮助文件系统，它代替了早先的WinHelp帮助系统，能在Windows 98或NT及以上版本的操作系统中直接运行。
编译CHM
QuickCHM未注册时，只能编辑最多20个节点的项目，在制作CHM文件前，最好把要编译进CHM中的文件编辑成HTML网页文件，CHM格式的文件支持所有的网页元素，所以你可以随心所欲地在Dreamweaver等网页编辑软件中编辑HTML文件。QuickCHM自带一个简易的网页编辑器，利用它可以编辑一些简单的网页，一般的做法是在Dreamweaver中做好网页，然后在QuickCHM中进行局部的修改。
需要注意的是编译进CHM文档中的文件最好都放在同一个文件夹中。
启动QuickCHM，在菜单栏执行“文件→新建”命令，新建一个“hhp”项目。切换到“目录”页，在菜单栏执行“主题→导入→添加文件夹”，导入待编译的文件夹中的文件，注意，在弹出的“添加文件夹”对话框中，可以使用过滤器，防止图片等某些类型的文件进入目录。在默认的情况下，进入目录中的各节点即主题都是以网页标题显示的（如图1），也可以在“系统选项”中设置为以文件名显示。接下来的任务，就是编辑目录和网页，下面就以这两个方面作简单的介绍。
编辑目录：
目录的编辑主要是重命名主题，修改主题图标，排序主题，嵌套主题，新建主题和删除主题，这些都可以利用右键快捷菜单和“目录”页上的按钮完成。
编辑网页：
QuickCHM集成了一个所见即所得的网页编辑器，利用QuickCHM提供的网页编辑工具箱（如图1），可以完成大部分的网页操作。切换到“源文件”页，可以对HTML源代码进行直接修改。和多数网页编辑软件一样，切换到“预览”页，可以对当前网页实时预览。
图1
利用同样的方法，还可以给帮助系统做一个“索引”页。
目录和网页编辑完成以后，就可以输出CHM文档了，不过在输出前也可以把它保存为一个“.hhp”项目，以便日后继续编辑。点击工具栏上的“编译”按钮，编译完成，如图2所示，这是利用上述的方法制作的“瑞星杀毒软件2004版”的帮助系统，从图中可以看出，这个帮助系统的“面板”上只有“目录”页，没有“索引”页。
图2
事实上，CHM文件的这个阅读平台即“浏览窗体”的所有部分都可以在“编译”前进行修改和定制，若你做进CHM帮助系统的各网页间都能相互导航，我们甚至可以隐藏或关闭整个“面板”。
在菜单栏上执行“选项→项目选项”命令，弹出“参数”对话框，如图3所示，在这里可以设定“主页”、“默认页”，显示或隐藏工具栏按钮和标题，显示或隐藏面板及面板上的目录、索引等，在这里还可以设定目录的表现方式和整个窗体的外观，添加“闪屏”（启动时一个一闪而过的图片，相当于软件的启动画面）等，当然了，以上的所有设置必须在“编译”前设置才能看到效果。
图3
反编译CHM
QuickCHM不仅能把HTML网页、文本文件、图片等编译为一个CHM文件， 而且还能反编译一个CHM文件，也就是说，利用QuickCHM，可以释放CHM文件中的HTML文件、文本文件、图片文件等资源，并且它能够恢复源文件的全部目录结构和文件名，以便帮助我们得到源文件进行资料恢复或二次编辑。
启动QuickCHM，在菜单栏执行“文件→反编译”，在弹出的对话框中选择要进行反编译的CHM文件以及反编译得到的HTML文件和图片等其它文件资源的保存位置，点击“确定”，反编译即可完成，同时保存HTML文件和图片等其它文件的文件夹被打开。
可以看到，需要还原文件已经出现在这个文件夹中了。
4. 软件实施文档怎么写
我是从研发步入实施的，研发需要 项目说明书 概要设计文档 详细设计文档 业务模型流程图
测试需要 测试用例 测试bug文档 迭代测试问题反馈 测试报告 压力和性能测试文档 不过小软件没有人做这些压力和性能测试 ，主要做黑盒测试，就是测试功能完整性。
实施需要 软件实施环境的需求文档 软件实施的工期计划以及各模块的具体实施计划 软件用户使用手册，让用户可以快速上手操作，最好图文并茂简单易懂，可以使用wps格式excel格式或者pdf格式，我不太看好ppt，那个真不方便做手册，希望能帮助你，谢谢！
转载请注明出处育才学习网 » 怎么给软件写帮助文档