采用EXCEL作为软件过程文档承载物

    

     在软件工程的整个过程中，文档是作为沟通交流的重要产物，不论是与需求方的沟通交流需要用到文档，软件公司内部也不可缺少。但是传统上的WORD文档表现形式存在阅读困难、描述不够直观的缺点。我曾经任职的公司转变了一下思路，采用EXCEL作为文档的承载物，安装UML的思想进行了文档模板化，使得公司与客户交流更加通畅，公司内部任务布置更明确，各岗位便于从文档中获取需要信息，文档更加易读的优点。现在简单介绍一下如何使用EXCEL作为我们软件工程的各种文档内容的承载物。

     我们知道在软件工程的过程中分为需求获取、需求分析、软件设计、代码实现、软件测试、软件部署及软件维护等阶段。在这些阶段中都会有各种的阶段产物，这些阶段产物就是软件工程中重要的成果，当没一阶段的产物完成度都非常高时，则意味着我们最终成果越接近成功，与客户的期望越一致。可惜的是，传统的文档是采用WORD文档进行承载，内容主要采用文字描述加上表格描述及部分图片信息，这种方式的描述阅读起来比较困难，一旦描述的内容太过复杂，容易导致阅读人员的耐心下降，草草阅读了事。而采用EXCEL作为承载物，可以清晰的区分各阶段，并通过图文并茂的方式清晰描述。

     采用EXCEL文档作为我们各项分析的内容承载物，首先通过sheet做为内容的框架划分。一个sheet记录一个大的方面，从需求获取的方面可以划分为：涉众表单、组织结构、业务用例、业务边界、业务用例场景、UI简图等各种方面。从软件详细的设计方面可以划分为：数据库结构、系统流程图、系统功能点、模块间接口、公共函数&方法、公共算法、具体功能界面设计（多sheet，每个功能页面使用一个sheet），详细设计文档采用每个功能模块一个EXCEL文档的方式进行组织。通过这样的文档结构，我们每次与客户交流完毕都可以针对当次访谈或会议形成一份文档或文档的一部分并提交给客户，相当于每次都要成果产生，提升客户对公司的信赖感。同时，文档的图文并茂的形式便于客户理解，并可以及时就内容异议部分进行沟通。在公司内部，开发人员和测试人员可以从详细设计文档中按照自己岗位的需求获取有用的部分，由于采用了UI+文字描述的方式，避免了阅读困难，同时文档也更加直观。

 

由于整套模板设计到公司内部的管理约束，所以这里只简单描述一下某几个设计文档的sheet如何编写的指引，有兴趣的可以自己想一想自己任职公司是否有采用这种方式的价值。

 

 

文档划分原则：

1.同一个Excel文档中建议只包含一个业务单元的需求描述，或多个相关的简单业务单元。

2.一个界面标签中，建议仅包括一个功能模块的相关界面。（如一级界面、二级界面及相关的操作界面）关联界面之间建议用虚线箭头进行链接。

需求采用“UI+要点批注”的描述方式：

1、字体统一采用“规定字体”。

2、原始描述要求使用黑色字体；项目设计人员的设计要求采用蓝色字体；需求变更要求使用红色字体。

3、功能界面的sheet命名建议按照“目录”中的“序号+目录名称”的方式。

业务模型业务流程说明：

1）排版要求：流程说明与流程图并列显示，这样便于阅读；

2）流程图：要求使用“泳道图”方式，线上步骤采用“蓝底黑字”格式，线下步骤采用“白底黑字”格式。

3）流程说明：要求对流程图上对关键步骤进行编号，按照编号进行逐一流程说明。

页面模型sheet文档截图：

详细设计文档sheet组成

UI+描述