【技术实现步骤摘要】
本专利技术涉及嵌入式系统控制软件，尤其涉及一种软件说明文档自动生成方法。
技术介绍
1、软件开发文档是软件开发使用和维护的重要工具，特别对于复杂的车用嵌入式控制软件，软件标定工程师需要参照软件开发工程师书写的软件开发文档开展标定工作。软件开发文档通常需要详细地阐述软件各功能模块层级关系，分级表达各模块功能、逻辑，对输入、输出，及重要的中间变量进行说明。
2、目前，为了获取到软件开发文档，通常由软件开发工程师花费大量的时间进行人工书写整理排版，效率很低。并且由于当前并没有专门对软件说明的格式进行规范，导致软件开发文档的呈现效果五花八门，不便于针对性阅读，尤其是在使用过程中，难以查找到某一具体细节的说明。
3、因此，现有技术在制作软件说明文档的过程中，存在由于文档规范度不高导致条理性低，且自动化程度低的问题。
技术实现思路
1、有鉴于此，有必要提供一种软件说明文档自动生成方法，用以解决现有技术在制作软件说明文档的过程中，存在的由于文档规范度不高导致条理性低，且自动化程度低的问题。
2、为了解决上述问题，本专利技术提供一种软件说明文档自动生成方法，包括：
3、获取软件的多个功能模型，并基于功能模型的设计框架确定功能模型中的各层级各子功能单元模块；
4、获取各层级各子功能单元模块的模块名称、逻辑策略模型图片和说明文本；
5、根据设计框架对模块名称、逻辑策略模型图片和说明文本按层级关系进行编号，得到功能模型说明文档；p>
6、对多个功能模型说明文档进行排序组合，得到软件说明文档。
7、进一步地，功能模型说明文档包括功能模型的数据字典信息，数据字典信息包括变量分类和变量具体数据类型；
8、其中，变量分类至少包括输入变量、输出变量、常量、标定量和中间变量；
9、变量具体数据类型至少包括变量名称、数据类型、维度、单位、初始值和释义信息。
10、进一步地，获取各层级各子功能单元模块的说明文本，包括：
11、基于第一预设脚本获取功能模型的变量分类；
12、基于第二预设脚本获取功能模型的数据字典信息中的变量具体数据类型；
13、按照预设规则对变量分类进行排序，并将变量具体数据类型表述填充至对应位置，得到说明文本。
14、进一步地，按照预设规则对变量分类进行排序，并将变量具体数据类型表述填充至对应位置，得到说明文本，包括：
15、根据变量分类，搭建数据字典说明表格，以变量分类为标题，对变量具体数据类型进行分类整理，得到说明文本。
16、进一步地，根据设计框架对模块名称、逻辑策略模型图片和说明文本按层级关系进行编号，得到功能模型说明文档，包括：
17、根据设计框架分别确定模块名称的模块名称编号、逻辑策略模型图片的图片编号和说明文本的说明文本编号；
18、根据模块名称编号、图片编号和说明文本编号对模块名称、逻辑策略模型图片和说明文本进行排序，得到功能模型说明文档；
19、其中，将子模块名称设定为功能模型说明文档的对应层级标题。
20、进一步地，根据模块名称编号、图片编号和说明文本编号对模块名称、逻辑策略模型图片和说明文本进行排序，得到功能模型说明文档之后，还包括：
21、通过图片文字分离技术，对说明文档的逻辑策略模型图片进行图文分离处理，得到更新图片；
22、其中，更新图片中的文字可以被独立编辑和检索。
23、进一步地，说明文档还包括数据字典说明列表；根据模块名称编号、图片编号和说明文本编号对模块名称、逻辑策略模型图片和说明文本进行排序，得到功能模型说明文档之后，还包括：
24、获取各层级各子功能单元模块对应的各层级标题文本；
25、通过链接生成技术，对各层级标题文本进行自动链接处理，得到相互关联的标题文本；
26、获取数据字典说明列表的变量名称；
27、通过链接生成技术，对说明文档中的变量名称进行自动链接处理，得到相互关联的变量名称。
28、进一步地，说明文档还包括变更记录表；得到软件说明文档之后，还包括：
29、获取说明文档的变更信息，并根据变更信息构建变更记录表。
30、进一步地，得到软件说明文档之后，还包括：
31、设置文本格式标准，并基于文本格式标准对说明文档进行格式修订。
32、进一步地，对多个功能模型的多个说明文档进行排序组合，得到软件说明文档之后，还包括：
33、将软件说明文档合并至软件说明文档库，得到更新软件说明文档库；
34、对更新软件说明文档库进行目录更新，得到更新软件说明文档库的新目录；
35、基于更新软件说明文档库生成新检索索引；
36、其中，新检索索引包括软件说明文档的所有文字。
37、采用上述技术方案的有益效果是：本专利技术提供一种软件说明文档自动生成方法，该方法通过将软件的功能模型作为一个整体进行研究，不仅提高了数据的条理性时，还保证了数据完整性；另外，模型每个子功能单元的说明文本能够根据设计需要获取到；最后，通过将设计框架作为软件说明文档的骨架结构，并根据获取到的说明文本对骨架结构进行适应性填充，进而得到软件说明文档，能够有效利用软件开发过程中的功能模型的设计框架，保证软件说明文档与软件的结构框架完全一致，保证软件说明文档的条理性，并且由于本方法能够根据现有数据自动生成软件说明文档，因而大大提高了获取软件说明文档的自动化效率。
本文档来自技高网...【技术保护点】
1.一种软件说明文档自动生成方法，其特征在于，包括：
2.根据权利要求1所述的软件说明文档自动生成方法，其特征在于，所述功能模型说明文档包括所述功能模型的数据字典信息，所述数据字典信息包括变量分类和变量具体数据类型；
3.根据权利要求2所述的软件说明文档自动生成方法，其特征在于，所述获取所述各层级各子功能单元模块的说明文本，包括：
4.根据权利要求3所述的软件说明文档自动生成方法，其特征在于，所述按照预设规则对所述变量分类进行排序，并将所述变量具体数据类型表述填充至对应位置，得到所述说明文本，包括：
5.根据权利要求1所述的软件说明文档自动生成方法，其特征在于，所述根据所述设计框架对所述模块名称、所述逻辑策略模型图片和所述说明文本按层级关系进行编号，得到功能模型说明文档，包括：
6.根据权利要求5所述的软件说明文档自动生成方法，其特征在于，所述根据所述模块名称编号、图片编号和所述说明文本编号对所述模块名称、所述逻辑策略模型图片和所述说明文本进行排序，得到所述功能模型说明文档之后，还包括：
7.根据权利要求6所
8.根据权利要求7所述的软件说明文档自动生成方法，其特征在于，所述说明文档还包括变更记录表；得到所述软件说明文档之后，还包括：
9.根据权利要求8所述的软件说明文档自动生成方法，其特征在于，得到所述软件说明文档之后，还包括：
10.根据权利要求9所述的软件说明文档自动生成方法，其特征在于，所述对多个所述功能模型的多个所述说明文档进行排序组合，得到所述软件说明文档之后，还包括：
...【技术特征摘要】
1.一种软件说明文档自动生成方法，其特征在于，包括：
2.根据权利要求1所述的软件说明文档自动生成方法，其特征在于，所述功能模型说明文档包括所述功能模型的数据字典信息，所述数据字典信息包括变量分类和变量具体数据类型；
3.根据权利要求2所述的软件说明文档自动生成方法，其特征在于，所述获取所述各层级各子功能单元模块的说明文本，包括：
4.根据权利要求3所述的软件说明文档自动生成方法，其特征在于，所述按照预设规则对所述变量分类进行排序，并将所述变量具体数据类型表述填充至对应位置，得到所述说明文本，包括：
5.根据权利要求1所述的软件说明文档自动生成方法，其特征在于，所述根据所述设计框架对所述模块名称、所述逻辑策略模型图片和所述说明文本按层级关系进行编号，得到功能模型说明文档，包括：
6.根据权利要求5所述的软件说明文档自动生成方法，其特征在于，所述根据所...
【专利技术属性】
技术研发人员：李芳，刘亚林，李婉笛，李相融，王梅俊，程欢，白桃李，李林，郑攀，于俊鹏，
申请(专利权)人：东风商用车有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。