每个开发人员都知道改写原有的应用程序是一项多么艰苦的事情。对先前开发小组思维模式进行逆向工程是对开发人员技术水平的真正测试。真正阻碍这一过程的一件事是没有相关文档可用，而且同时（原有）应用程序所涉及的开发人员全部不在。
所以，既然开发人员知道即使最基本的文档都能够成为很有用的工具，那么为什么我们常常会忽视这一项工作呢？我所认识的大多数开发人员都承认他们没有足够的时间来编写文档。但是，这项平凡的工作确实能够为你或者你的同事节省大量的开发时间。
如果你需要编写文档，那就看看本文的提示吧，你会知道帮助文档需要包含哪些内容，以及在哪些地方可以找到帮助完成这一任务的工具。
描述应用程序的核心元素
从一开始就概括应用程序的技术细节当然是非常的理想的。简化这一过程的一种方式是首先抓住每个应用程序都有的四个核心元素：数据、业务规则、用户界面，以及安全。下面我就详细解释一下每个部分：
- 数据：系统所使用的后端数据既可以简单到只有几个表格，也可以复杂到有数百个表格，甚至是存储过程、视图和其他等等。当开发人员面对新的系统时，手里有最新的数据模型／图表就能够为他们节省大量的时间。
- 业务规则：目前，进行系统设计的方法是把业务规则放在设计人员自己（开发）的对象里，同数据和用户界面隔离开，但是这未必就是正确的。一个概述系统业务规则的简单文档能够在很大程度上增强读者对应用程序的用途的理解。
- 用户界面：我认为用户界面是比较容易理解的应用程序特性之一，这主要是因为通过启动和使用应用程序你就可以对它有一个比较好的感受。由于常常会使用自定义控件或者第三方的工具，所以理解起来会稍稍困难一些。为用户界面编写文档的一个好方法是提供系统所用的窗体和其它元素的列表及其详细说明。
- 安全：开发人员在给系统编写帮助文档的时候常常会忽视安全这一特性。当你查看原有代码的时候，你毫无疑问将注意到不同地方都设置了安全检查，但是要对应用程序的安全模型有一个整体上的认识是很困难的。
