MBT文档模型化、工程化生成工具用户手册 30倍效率文档撰写工程化方法 A model based document builder

MBT文档模型化生成工具旨在简化工程文档撰写,提供30倍效率提升,支持Latex、Markdown等脚本,实现文档要素建模及自动化处理,适用于软件工程领域的多种文档类型。

MBT文档模型化生成工具用户手册

30倍效率文档撰写工程化方法

A model based document builder

  1. 简介

在软件工程领域,工程文档通常主要包括实施方案、需求分析、软件设计、测试报告、验收大纲、用户手册等几种。这些文档中,通常要求内容丰富,能够体现整个软件工程大部分信息;易于理解,需要制作各种表格,绘制各种图形,包括UML图。可见,文档撰写的工作量巨大,需要有工具支撑,以提高工作效率。

“文档模型化生成工具”的研制目的是为了简化工程文档,减少文档撰写的工作量,所针对的实际现象是:

(1)产品研发人员之间文档样式、模板不统一,格式过于复杂,编辑、合并、分块工作会耗费大量时间。

(2)同一项目中,文档之间联系紧密,其中往往包括一些重复信息。

(3)章节之间,隐含了组成、从属关系信息。

(4)表格制作、图形绘制工作工作量大。

(5)段落、插图、表格、目录、编号、页码、样式等文档要素要进行正确美观的格式调整和控制,会占据用户大量时间。

(6)文档内容多

1.◇ 可行性分析报告:     说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述 为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案 的理由。   2.◇ 项目开发计划:     为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开 发的进度、开发经费的预算、所需的硬件及软件资源等。   3.◇ 软件需求说明书(软件规格说明书,系统测试需要的标准文档):    对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是 在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实 施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护 系统数据文件做好准备。   4.◇ 概要设计说明书:     该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序 的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等, 为详细设计提供基础。   5.◇ 详细设计说明书:      着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。   6.◇ 用户操作手册:      本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件 得到具体的了解,为操作人员提供该软件各种运行情况的有关知识,特别是操作方法 的具体细节。   7.◇ 测试计划:     为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括 测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。   8.◇ 测试分析报告:      测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分 析,并提出测试的结论意见。   9.◇ 开发进度月报:      该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括 进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月 的打算等。   10.◇ 项目开发总结报告:      软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况, 如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价, 总结出经验和教训。   11.◇ 软件维护手册:     主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护 过程的说明,便于软件的维护。   12.◇ 软件问题报告:      指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为 软件修改提供准备文档。   13.◇ 软件修改报告:      软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在 的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值