在对需求管理平台进行迁移的时候,经常会碰到关于“Polarion需求文档如何导入,以及导入之后格式乱了怎么去整理”的问题,表面上看起来,这只是把Word、Excel或者旧系统里面的数据搬到Polarion里面去,但是实际上的困难在于,文档的结构能不能被系统给识别出来,标题的级别能不能变成需求的级别,还有正文、表格、图片和编号在导入之后是不是会发生变形,Polarion这个系统支持围绕Word文档来进行导入,并且可以配置需求的筛选规则,在集成的场景里面,系统也提供了导入Word文档从而创建Polarion Document的接口。
一、Polarion需求文档怎么导入
在把需求文档导入到Polarion之前,一般不建议直接把原文件传进去,如果需求文档里面的标题很乱,编号是手动输入的,表格嵌套得太深,系统导入以后就容易把内容变成一堆很难整理的乱码,比较稳妥的办法是,操作人员先去把文档整理成适合Polarion识别的结构,然后再去执行导入的流程。
1、原始需求文档的整理
在导入之前,需要先检查Word或者Excel里面的内容结构,需求的标题最好是要使用统一的样式,比如一级标题、二级标题和三级标题,不能靠手动去加粗或者放大字号来当成标题,因为Polarion在导入Word需求的时候,系统通常需要通过标题、段落的样式或者导入的规则,来判断哪些内容应该变成需求项,而哪些内容只是普通的说明文字。
2、导入方式的选择
通常的做法是,先通过【Project】然后点击【Documents】进入到目标空间里面,新建或者选择其中一个Document。
接着去使用Word导入的功能,由于不同的Polarion版本和项目配置,入口的名称可能会有一些不一样,但是核心的逻辑都是差不多的,就是选择文件、配置导入的规则、预览导入的结果,最后确认生成Document或者Work Item。
3、预览导入结果后再去确认
预览这个步骤是不能跳过的,在预览的阶段里,需要重点去看三件事,分别是标题有没有被识别成需求项、层级有没有搞错、正文有没有跑到错误的字段里面去,特别是当Word文档里面的“说明段落”和“正式需求”混在一起的时候,如果导入的规则没有配置好,说明文字就很可能会被系统当成需求来生成。
二、Polarion需求文档导入后格式错乱怎么整理
需求文档在导入之后如果出现了格式错乱,这通常不单单是Polarion这一个系统的问题,而是由原文档的样式、导入的规则、字段的映射以及项目的模板共同引起的,在整理的时候,大家需要分清楚到底是“显示的格式错乱”,还是“需求的结构错乱”,因为这两者的处理办法是不一样的。
、
1、标题层级的错乱
如果一级标题、二级标题和三级标题都被系统变成了同一级,这就说明在导入的时候,系统没有正确地识别出Word的标题样式,可以先在Polarion的Document里面去检查需求的层级,然后再去对比原Word文档里的标题样式,很多文档看起来好像有层级,但实际上只是人工敲进去的编号,比如写成“1、”“1.1”“1.1.1”,却没有真正去使用Word自带的标题样式。
2、正文格式、图片和表格的错乱
正文错乱比较常见的表现是换行没有了、字体不一样、表格变形以及图片的位置发生偏移,对于需求管理工作来说,大家其实不用追求和Word一模一样的排版,重点应该放在内容是不是清楚、证据有没有保留下来、需求是不是可以被追踪上面。
表格如果只是起到辅助说明的作用,那就可以把它保留在Description里面,如果是表格的每一行都代表着独立的需求,那就要考虑按照行把它拆分成Work Item,Polarion在比较早的时候就支持把Word的表格行导入成单独的Work Item了,而且大家还可以在导入之前去预览和调整结果。
3、字段映射的错乱
导入之后,如果需求的标题跑到描述里面去了,或者状态、优先级、类型这些没有填上,这通常是因为字段映射没有配置好,这就需要去检查导入规则里面Title、Description、Type、Status、Severity等字段的对应关系。
三、导入后如何减少返工和维护成本
Polarion需求文档的导入并不是一次性的搬运工作,因为在后面还会涉及到评审、变更、追踪以及测试覆盖等环节,在导入的时候做得越规范,后面的维护就会越轻松,如果导入的时候只想图快,那后面很可能就要面临反复返工的局面。
1、建立导入前的检查清单
在每次导入之前,可以固定去检查这么几项内容,也就是标题样式有没有统一、编号是不是自动生成的、表格有没有过度嵌套、图片清不清晰、需求的字段完不完整,以及有没有重复的编号,这个检查不用做得很复杂,但是需要坚持去做。
2、先进行小批量的试导入
大家不要一上来就去导入完整的需求规格说明书,可以先截取其中的某一个章节,里面要包含标题、正文、表格、图片和典型的需求字段,用来做一次小范围的试导入,等到确认了层级、字段和格式都基本可以接受之后,再去导入完整的文档。
3、形成统一的模板
如果团队在后面还需要持续地导入需求文档,建议大家去固定一套Word或者Excel的模板,在模板里面把标题的层级、需求的字段、表格的格式和图片放置的规则都提前规定好,这样每次在导入的时候,Polarion的识别逻辑就会更稳定,人工整理的成本也会降低很多。
总结
Polarion需求文档导入的关键点,并不是单纯地去找系统的导入按钮,而是要把原始的文档整理成Polarion可以识别、可以追踪以及可以维护的结构,在导入之前需要规范好标题、字段和表格,在导入的时候要认真去配置规则并且查看预览的效果,在导入之后则要按照标题层级、正文格式和字段映射这三类问题分别去进行整理,只要前期的模板统一了、试导入做充分了,那么后面不管是做需求评审、版本变更,还是做测试追踪,过程都会顺畅很多。