中国普天项目信息管理系统之工程阶段性文档需求规格说明书.doc

中国普天信息产业股份有限公司 通信产业事业本部项目信息管理系统工程管理/工程文档管理需求规格说明书 文档编写： 王昊航 提交日期： 审 批 人： 北邮项目组2009-9-3Presale-004 工程文档管理模块 需求规格说明书文档维护记录撰写人修改时间原版本号修改内容介绍王昊航2009-9-3V1.0初稿目 录1.1 编写目的31.2 术语41.3 预期读者和阅读建议41.4 应用范围41.5 参考文档42 模块功能概述52.1 功能描述52.2 业务流程53 系统用例图53.1 系统用例图53.2 角色说明53.3 用例描述64 功能详细说明64.1 工程文档管理64.1.1 提交过程文档64.1.2 日报催办64.1.3 审批日报74.1.4 汇总工程过程文档74.1.5 查询工程过程文档74.1.6 文档内容类别管理75 数据字典75.1 数据模型95.1.1 日报表95.1.2 周报表95.1.3 月报表95.1.4 文档类别名称表95.1.5 日报-类别名称关联表95.1.6 周报-类别名称关联表95.1.7 月报-类别名称关联表95.2 关键实体关系描述91 引言1.1 编写目的系统需求说明书的编制是为了使用户和软件开发人员、实施者对该软件的运行环境、功能需求的初始规定有一个共同的理解，使之成为整个开发、实施部署工作的基础，同时为系统总体设计提供需求说明。此文档包含了中国普天项目信息管理系统之工程阶段性文档管理模块的各种客户需求，并提供给项目经理、设计人员和开发人员参考。1.2 术语阶段性文档：项目在进行到某一个阶段必须提交的文档。 文档催办：文档提交者如果没有及时提交，文档管理员会进行催促，以邮件形式通知对应文档提交者文档审核：文档审批者对提交者提交的文档进行审批，如果审核不通过则驳回给提交者让提交者重新提交文档。1.3 预期读者和阅读建议预期读者：北邮项目组成员和普天公司客户阅读建议：项目需求说明书主要帮助项目开发人员熟悉需求，便于正确开发，因此，项目开发人员必须熟悉本文档。1.4 应用范围工程阶段性文档管理模块是工程过程管理的一个子模块，该模块的总体目标是在中国普天系统事业产业本部范围内对工程进行过程中的文档进行管理。所开发系统名称：中国普天项目信息管理系统之工程文档管理模块项目委托单位：中国普天股份有限公司项目开发单位：北京邮电大学软件用户：中国普天系统事业产业本部所有员工及下属部门1.5 参考文档工程二期模块需求规格说明书2 模块功能概述2.1 功能描述每个项目具有一个输入和输出文档列表，文档提交者需要根据此列表进行文档上传提交。如果没有及时提交文档，系统会催办提交者让其提交文档。文档提交之后需要有人对文档进行审核，审核如果不通过则需要提交人重新提交稳定。关注人员可以下载查看每个项目的具体文档。2.2 业务流程从角色角度谈业务流程：(1) 文档管理员定制文档阶段和每个阶段需要提交的输入输出文档。(2) 文档管理员上传公共输入文档,给每个项目指定需要提交的文档的责任人和审核人。(3) 文档提交人提交自己需要提交的文档。(4) 文档审核人审核文档提交人提交的文档并决定该文档审核通过或是驳回。(5) 如果文档提交人未及时提交文档，文档管理员要进行邮件催办。 具体的流程图如图下 图2.1 按角色业务流程图3 系统用例图3.1 系统用例图图3.1 系统用例图3.2 角色说明工程文档模块共有以下几个角色：文档提交者、文档管理员、文档审核人、文档关注人。以上文档管理员、文档关注人为系统角色、文档提交者和文档审核人均为系统中的其它工程人员。3.3 用例描述工程文档模块角色可以操作的权限功能如下：文档提交者：提交阶段性文档。 文档管理员：文档催办、查询阶段性文档。文档审核人：阶段性文档审核。文档关注人：查询阶段性文档。3.4 角色功能描述文档管理员文档提交者文档审核人文档关注人阶段性文档类型维护阶段性文档催办阶段性文档审核查询阶段性文档提交阶段性文档4 功能详细说明在工程阶段性文档管理模块中，对应业务的操作流程如下：(1) 文档管理员定制文档阶段和每个阶段需要提交的输入输出文档。(2) 文档管理员上传公共输入文档,给每个项目指定需要提交的文档的责任人和审核人。(3) 文档提交人提交自己需要提交的文档。(4) 文档审核人审核文档提交人提交的文档并决定该文档审核通过或是驳回。(5) 如果文档提交人未及时提交文档，文档管理员要进行邮件催办。具体功能点如下表：业务功能名称业务功能功能说明提交阶段性文档显示自己需要提交的文档列表进入提交阶段性文档功能，显示出目前自己需要提交的文档列表，列表栏有工程名称、文档名称、模板来源、输入来源、责任人/部门 文档状态 驳回意见 上传文档上传选择本地文档进行上传、上传后文档状态从未提交或者驳回变为已提交查看我的历史文档记录根据时间和工程名称可以查找出已提交过的文档列表，列表栏有工程名称、文档名称、模板来源、输入来源、文档状态、下载、重新上传(如果已审核则无法重新上传)文档催办查看提交列表可以选择工程 选择是输入或者输出显示出当前条件下的文档类表。列表栏有阶段文档名称、模板来源、输入来源、责任人/部门、文档状态、下载（如果是未提交或驳回则下载无效）列表前有复选框 可以批量更改状态文档催办对未提交的人员进行催办，以邮件形式告知 可以批量催办文档审核显示审核文档列表列表栏有项目名称、阶段名称、文档名称、填写责任人 查看 驳回最下面有驳回意见框文档状态更改可以复选更改状态为已确认文档驳回填写文档列表后的驳回意见 点击驳回按钮 文档状态变为已驳回文档维护阶段维护增删改目前所有的文档阶段文档设置添加阶段 文档名称 、输入或者输出、如果是输入有模板来源 输入来源 责任人 模板上传。项目文档设置项目列表显示目前所有项目 列表有项目名称 输入文档和输出文档链接项目文档设置可以选择输入列表或者输出列表如果是没有输入模板的输入文档可以填写文档责任人和审核人。如果是输出文档则必须有文档责任人和审核人文档查询文档查询根据工程名称和文档名称、文档状态可以进行查询（支持模糊匹配） 查询的结果为一列表显示项目名称 文档名称 责任人/部门 文档状态 下载链接（如果未提交则无法下载）4.1 提交阶段性文档 填写文档的功能点有：显示需要提交的文档列表、文档上传、查看我的历史文档记录。4.1.1 显示需提交的文档列表进入提交阶段性文档功能，显示出目前自己需要提交的文档列表，列表栏有工程名称、文档名称、模板来源、输入来源、责任人、文档状态、驳回意见、上传(为一链接)。如果驳回意见为空则无驳回意见链接。4.1.2 文档上传 点击上传进入上传页面，选择本地文件进行上传。上传时有进度条提示上传进度，上传完成后提示上传完成，文档状态变为已提交。上传文档大小限制？4.1.3 查看我的历史填写记录 显示出责任人为本人的所有文档列表。列表栏有工程名称、文档名称、模板来源、输入来源、责任人、文档状态、驳回意见、上传。如果状态不是已审核的文档可以重新上传。4.2 文档催办“文档催办”由文档管理员使用，包括的功能点有：查看提交列表、文档催办。4.2.1 查看提交列表 进入查看提交列表功能，首先要选择提交文档范围，筛选条件有工程名称和文档类型(输入或是输出)，工程名称支持全选和复选，点击查看显示出当前条件下状态为未提交的文档类表。列表栏有阶段文档名称、文档类型、责任人/部门、提交状态、驳回意见、下载（如果是未提交则下载链接失效）列表前有复选框，可以批量选择。4.2.2 文档催办 根据查看提交列表中所复选的文档，点击催办按钮，系统会自动发送邮件催办该文档责任人提交文档。4.3 文档审核“文档审核”可由指定的审核人使用，包括的功能点有：显示审核文档列表、文档审核通过、文档驳回。4.3.1 显示审核文档列表 文档审核人点击文档审核，可以看到目前自己需要审核的文档列表（文档状态已提交）。列表栏有阶段文档名称、文档类型、责任人、提交状态、下载。列表前有单选框可以选择某一文档。列表下方有驳回意见栏，最下方有审核通过、文档驳回、返回按钮。4.3.2 文档审核通过 点击审核通过，审核文档列表的单选框选中的文档的状态会变为已审核。4.3.3 文档驳回 填写驳回意见栏，点击文档驳回。审核文档列表的单选框选中的文档状态会变为未提交。如果不填写驳回意见栏，点击驳回系统会提示“请填写驳回意见”。4.3.4 代办事宜如果有需要当前用户进行审核的文档时，系统会在页面右侧的菜单里加入待办事宜的通知并提示有几个需要审核的文档，点击“您目前有X个文档审核事务”链接后会进入审核文档列表页面。4.4 文档维护“文档维护”由文档管理员使用，包括的功能点有：阶段维护、增加文档、项目文档维护。4.4.1 阶段维护 点击阶段维护功能，文档管理员可以增加、删除、修改目前文档的阶段。删除阶段会级联删除阶段下目前的已有文档，需要给出提示信息“删除阶段会删除目前阶段下文档，请确认是否删除”。4.4.2 全局文档维护点击全局文档维护功能，文档管理员可以增加、删除、修改目前的全局文档。增加文档时要选择阶段，填写文档名称 、文档类型、如果是输入有模板来源、输入来源、责任人，如果是输出文档有文档名称、责任人、审核人。可以在此处上传输入文档。如果在此处上传则所有项目中的此文档均为这个上传的文档。修改页面同增加页面。删除文档会级联删除所有项目中的该文档，需要给出提示信息“删除文档类型会删除目前所有改类型的文档，请确认是否删除”。4.5 项目文档设置4.5.1 项目文档列表点击项目文档维护功能，系统会列出目前所有的项目列表，列表的每一行会列出项目名称，之后有对应的项目文档链接。4.5.2 项目文档设置 点击项目文档链接会列出改项目所有文档列表，列表栏有模板来源、输入来源、文档名称、责任人、审核人、编辑。点击列表前的单选框后可以修改文档的属性。每个文档只能指定一个责任人和审核人。 4.6 文档查询“文档查询”由文档管理员和文档关注人员使用，包括的功能点有文档查询。4.6.1 文档查询 根据工程名称和文档名称、文档状态可以进行查询（支持模糊匹配） 查询的结果为一列表显示项目名称、文档名称、责任人、审核人、文档状态、驳回意见、下载链接（如果未提交则无法下载）5 数据字典5.1 数据模型1. 阶段文档与阶段，工程，员工是多对一的关系。2. 阶段与阶段文档是一对多关系。3. 工程与阶段文档是一对多关系。4. 员工与阶段文档是一对多关系。5. 文档模板与阶段是多对一关系。实体关系图如下：（1）.（2）5.2 关键实体描述表名: StageDocument 中文名：阶段文档字段名称中文意思字段类型字段长度小数位数允许空是否主键默认值ID唯一标识varchar2550NO是主键documentname文档名称varchar2550YEScategory文档类型varchar2550YESstate文档状态varchar2550YESpatternsource模板来源varchar2550YESinsource输入来源varchar2550YESpath文档路径varchar2550YESsubmittime提交时间varchar2550YEScomments驳回意见varchar2550YESresponsible责任人,外键：员工IDvarchar2550YESreviewer审核人，外键：员工IDvarchar2550YESengineering_id外键：工程IDvarchar2550YESstage_id外键：阶段IDvarchar2550YES表名: Stage 中文名：阶段字段名称中文意思字段类型字段长度小数位数允许空是否主键默认值ID唯一标识varchar2550NO是主键stagename阶段名称varchar2550YES表名: DocumentPattern 中文名：文档模板字段名称中文意思字段类型字段长度小数位数允许空是否主键默认值ID唯一标识varchar2550NO是主键documentname文档名称varchar2550YEScategory文档类型varchar2550YESpatternsource模板来源varchar2550YESinsource输入来源varchar2550YESpath文档路径varchar2550YESstage_id外键：阶段IDvarchar2550YES6 外部接口工程文档模块目前没有外部接口。7 非功能性需求软件产品的非功能性需求包括系统的性能、可靠性、可维护性、可扩充性和对技术和对业务的适应性等。在这里可以看到非功能性需求涉及的范围很广，软件产品本身不是孤立存在的，还涉及到诸多外在环境的影响。非功能性需求必须考虑软件既要可用，又要易用。本系统考虑到的非功能性需求主要基于以下三种要素：7.1 完整性一个软件系统必须完整，因此不仅仅包括了可执行的程序，还包括了在线帮助，数据和用户管理，日志异常查询，自动升级等相关功能特征。这些需求不仅仅是为了满足用户的需要，也是为了我们后续维护和监控系统的需要。7.2 可靠性系统的可靠性，可维护性和适应性是密不可分的。当系统出现故障和用户出现错误的操作后是否支持恢复，当用户在使用过程中遇到错误的时候是否可以立即定位问题，但业务场景和逻辑发生变化的时候系统是否支持，当网络不稳定或使用中异常中断的情况下系统是否都有相应的容错措施，这些都是