软件说明书编辑工具

最近需要做本人接手的软件说明文档。仔细想想有很多事需要做。

首先是有界面的工具，需要仔细描述每个功能。没有界面的自动化工具，也要详细描述它的功能和位置。总之， 完整。

其次这个描述文档要可以方便的在内部分发和编辑。

还有这个文档要保持更新。

想了很多，觉得光靠我一个人写，太多了， 别的事都不用干了也要写上半个月。其次，文档写完了使用软件的人都基本不会看的， 有问题了照样还是来找我。最后，即使大家愿意看，但是遇到软件更新的时候， 难免文档和软件不同步，时间久了肯定还是会抛弃这些文档。不就白做了。

最后，我决定，做一个文档编辑工具给使用者，让他们自己写文档，遇到不会的来找我，这样解决工作量的问题和使用问题，自己写的自己能看懂的吧。其次，每次代码checkin，自动将changeset记录插入文档，解决文档更新的问题。然后加一个生成chm的功能，方便分发。

首先要解决的是编辑器用什么做。开始想到用word插件，稍微看了下太复杂。然后先用简单的richtextbox，要写的东西太多。后来想到到用webbrowser，应该是比较简单的吧。结果发现还是很复杂。第一个问题是如何进入编辑状态，第二个问题是进入编辑状态如何保留之前编辑的内容(因为进入编辑状态的时候会清掉之前编辑的内容)，第三个问题是这个页面要如何保存到DB。

其次要解决的是同步更新。我们项目用的TFS2012，它内部可能有写好的方法提供changeset的数据，但是还是图省事，直接从它的数据库里提取内容。这样做的时候，要在checkin的时候多写一点东西，把功能id带上。当有新的checkin动作后，用自动化工具将这些changeset同步到功能描述文档里。

最后加了一个按钮，点击之后可以导出chm文件。

附上可编辑的webbrowser控件，有需要的朋友可以用一下: https://files.cnblogs.com/sdassdas/HtmlEditor.rar

这个控件来自http://www.codeproject.com/Articles/17307/HTMLTextBox, 谢谢Jay Liu 的分享