第一章 SoDA是什么？　

　　SoDA是一种强有力的软件文档自动生成器。它使软件文档的生成实现了自动化，减化了软件开发中文档的生成过程，SoDA全面收集软件开发周期中各阶段信息并以之为基础制作文档。极大提高了文档的可用性、易用性和连贯性，使文档更加有效。SoDA可定制支持任何文档标准，从各种软件开发工具中截取数据，并可与各种支持编程语言的工具协同工作。　

软件文档生成的基本概念　

　　软件产业中许多领域需要生产文档，它们或是需要内部使用（例如设计文档和结构文档等），或是需要分发给最终用户（例如用户手册和在线帮助等）。有时文档也用于证明与软件外来要求的安全性、合理性以及与通用标准相一致。　

　　众所周知，软件分析和设计工具、程序开发环境以及程序测试工具中都包含了大量有关文档的信息，例如，设计文档需要包括软件设计的结构和内容，而这些信息是可以从软件设计环境中获得的，文档中还应包括设计过程中的有关图表，这些文档信息的收集是极为重要的。　

　　当然，软件开发环境中不可能包含文档所需要的全部信息，在最终的文档中还必须加入更全面的解释及其他方面的注释。您如果需要方便地自动创建文档、灵活地加入额外信息，SoDA向您提供了完美的解决方案。　

第二章 SoDA的解决方案　

　　SoDA可自动从软件开发环境中获取信息以制作文档，还可通过使用其它强大的文字处理工具如Microsoft Word和Adobe FrameMaker+SGML直接输入附加信息。同时，SoDA自动保持软件开发环境与文档中信息的安全一致性 。因此，使用SoDA，就可更省时省力地制作出更高质量的软件文档。　

　　SoDA制作的文档用途广泛，既可作为在线文档提供帮助又可以作为信息源的程序开发环境为团队人员提供超文本漫游，在软件分析、设计、编码和测试等方面加强了软件开发人员的信息交流，是团队保持良好的一致性。

第三章 关键性能　

　　3.1 SoDA自动从软件工程工具中获得信息──SoDA可识别与之相集成的各类工具的数据模型，在建立数据模板时，通过开发环境提供的API　AP接口获得的数据都可被SoDA直接使用。使用SoDA的图形用户界面，可方便地建立文档结构和信息源数据间的映像并将它放入模板。因此，SoDA通过自动从开发工具中获得所需数据而生成文档。

　　3.2 使用文字处理工具直接添加并保存补充的信息──SoDA最大的优点就是多次重复文档的自动生成而不会丢失手工输入的数据。因为SoDA与文字处理软件无缝接口。这样，在生成文档时，就可利用文字处理软件强大的功能创建、编辑文档，还可以嵌入图形，使文档更加精致完美。SoDA将各个版本手工输入的信息加以保存，并可保持文档信息与从开发环境中截取的信息相一致，大大缩减了软件文档制作的工作量。

　　3.3 定制文档模板而无需编程──使用SoDA，可以创建各具特色的文档模板以适用于开发团队中的每一成员。SoDA提供了简便易用，直观的图形用户界面，它是一种为创建文档模板的所见即所得的编辑器，这些文档模板定义了文档的“视觉及感受”，包括格式、结构和风格等，其作用与文档元素与数据源的映像一样。

　　3.4 创建模版──使用SoDA，可以创建基于ISO9000,IEEE,MIL-STD-2176A标准的文档模板，或是符合用户内部文档标准的模板，当然，SoDA也提供了预定义的模板。SoDA所见即所得特性定制的文档模板消除了原来所需的高价位的制作资源，从而进一步减少了文档生成的成本和时间。

　　3.5 检查文档和信息源的一致性──SoDA通过不断检查文档和信息源的一致性帮助用户保持文档制作与软件开发的同步。使用单一的按键点击，就可以在文档段和信息源间导航。当信息源发生改变文档会重新生成，用户可改变并查看变化。通过保持文档制作与软件开发的一致性，SoDA为用户提供从程序投资中获得最多收益的保证。

　　3.6 生成和不断更新文档──对于大型复杂的软件系统来说文档可能会达到数百页甚至数千页，随着软件的变化文档必须不断更新，SoDA通过只更新数据源中变化的部分而保持了高效率的文档更新。所以，SoDA的增值更新能力有效的提高了文档制作效率同时降低了计算资源负担。

　　3.7 使用多信息源生成一个单一的文档──SoDA可以通过多信息源提取信息从而生成一个文档，当用户创建一个文档时信息源的数量和种类不受限制。例如，用户可以自动地把从分析、设计工具以及编程环境或是用户的测试方案和故障跟踪工具中得到的信息生成文档，从而使用户无需掌握多种软件开发环境附带的文档生成工具。通过从多信息源中提取信息来建立单一文档，SoDA提供一个快速有效的途径去创建各类文档。

　　3.8通过用户所选择的工具提供了整个生命周期自动化──其它自动文档生成工具往往只能与一种或少数几种开发环境相联系，SoDA的Client/Server结构能使用户从任何软件开发环境中截取信息，如各种设计工具、编程环境以及测试工具等，SoDA通过这些工具保存的内部数据结构提取相关信息。用户可以使用SoDA去制作各种文档──如需求分析、设计要求、测试报告、故障跟踪报告、配置管理等──覆盖了整个软件开发周期的各个阶段。在开发全过程中用相同的文档自动化工具，可极大地消减培训和工具上的费用。因为SoDA可以同任何软件工程工具协同工作，不管是选择使用一种新的软件维护工具还是放弃一种正在使用的工具，用户的投资都可以得到保护。

　　3.9 提供对需求跟踪的支持──SoDA提供了有效而易用的文档结构帮助维护跟踪软件开发的整体过程，使程序的开发与需求要求相符合。SoDA可以产生需求跟踪报表，并可显示设计需求的执行情况、设计需求的满意程度、测试方面的满意程度。通过在不同软件开发阶段文档的超文本漫游，SoDA帮助用户提供从需求分析、设计、编码和测试自己的软件开发进程的在线导航。如果用户并不准备购买一个全方位的需求管理工具软件时，SoDA可作为您的辅助工具。　

第四章 SoDA是如何工作的？　

　　使用SoDA，首先规定一个在文档结构和信息源数据之间的映像，而后SoDA通过从信息源抽取相关数据而自动产生一个文档。使用文字处理工具，可以输入补充信息，在以后的各个版本中其将被保存不变。当用户查看已生成的文档时，数据还可被导航到源工具中去修改。源工具中信息发生改变时，部分或整个文档就会被重新生成去反映这个变化。

第五章 SoDA独到之处

　　从软件开发工具中抽取信息是繁复的、乏味的且易出错的工作，SoDA自动进行这种工作，便可使用户将精力能集中在创造性活动上，例如，用附加文本和图形描述系统组成之间的关系。总之，SoDA提供了有效的自动化的具备手工生成且灵活性的文档生成工具。

第六章 SoDA的产品结构　

　　SoDA包括一个SoDA的基本产品以及一个SoDA源域选件。基本产品括核心SoDA功能（信息抽取，文档生成和模板制作）；源域选件有将SoDA与其他软件工程工具结合在一起功能，例如，分析和设计工具，程序设计环境和测试工具。SoDA自带了标准文档模板，如数据字典模板、设计文档模板、结构文档模板和测试文档模板。目前支持的文字处理软件是Microsoft Word和Adobe FrameMaker+SGML。　

第七章 SoDA建立需求的能力　

　　SoDA与许多流行软件工程工具相集成，如果用户需要其它的集成方式，RATIONAL软件公司可按需求建立附加源域。一般来说，只要开发工具能够提供开放的应用程序接口（API），SoDA就可以和它们融为一体。