文档规范检查点

   在有些项目中，很多的模块的操作手册和验收文档是由开发人员编写，而他们在编写的时候，不是注重文档编写的细节，当文档到测试人员的手头时，文档可能遇到各种各样的问题，最糟糕的是测试人员需要帮他们整理统一文档格式，如果遇到这种测试工作时，就要提高开发人员编写文档的意识，我总结了一些我工作时经验，希望大家可以多多提意见，帮助我不断完善。51Testing软件测试网9Z/av+h^&g:wh
   首先我会跟测试主管或项目经理反馈，并提供一些文档规范的模块或考察点（即文档规范检查点），让开发人员重新提交文档，测试人员只根据文档检查点来验收文档，这样工作效率比较高，详细内容如：
F]A,Gi&G4NAA'W01、文档标题和文件名的正确性
+x+a4`+Y*GyeIS$U0  1） 文档名跟需求名一致，如：XXX需求，文档名是：XXX需求操作手册/XXX需求验收申请表51Testing软件测试网&EC:q&kD;K(M
  2） 文档标题名跟需求名一致，如：XXX需求，文档名是：XXX需求操作手册/XXX需求验收申请表51Testing软件测试网`Ul
d'~0{z8Ow|
  导致不正确的原因：开发人员很多情况下是修改原有其他需求的文档，常常忘记修改文档标题和文件名51Testing软件测试网Ke*Zzo(I'g
2、格式和字体统一51Testing软件测试网^.RP:QF-vd.gU
  1） 格式不一致的问题，文档里面的标题、标题一、标题二、标题三等格式参差不齐。51Testing软件测试网 c:^vfqjPW
  2） 字体不一致的问题，有的用黑体，有的用隶书，有的用宋体，等等
F0b
olAlkV![QVA0   规范的操作手册正确的格式和标题如下：51Testing软件测试网s@-BO!Hzyd
    标题：（宋体 二号 加粗）51Testing软件测试网*iW;l
q LR0fJ9oW
    标题一：（宋体 二号 加粗）51Testing软件测试网$p?
eOX]Aj
P5?\
    标题二：（宋体 三号 加粗）
U,F0l/w+J&S{xR ] u0    标题三：（宋体 四号 加粗）51Testing软件测试网%q9S%tP!Y3P8N%w
    标题四：（宋体 四号 加粗）（在下的字菜单的字体都是宋体 四号 加粗）
%R6KvLS6{ G9G0    正文字体：宋体  五号51Testing软件测试网/P'W
gd8^%w:J
  这个根据你们实际的要求定就可以的。
8A|u3X%|^03、文档树型菜单51Testing软件测试网6Ki;M7Ni PT?
  1）检查文档是否有树型菜单
} X]1`M2r\04、文档的完整性51Testing软件测试网I@:|MTC%q*J C9`D
5、文档的全面性
uxR+j?0m@^B06、截图51Testing软件测试网6d&G?0Z yGKd
1）流程图截错，跟实际描述的流程不一致，尽量不要拷贝，根据实际操作截图
(s{7yJ6~l0   错误截图：如描述销户业务时，截图却是续装业务流程图
cy#]VVOm?I
wT0   正确截图：根据实际描述的流程进行截图，截取销户业务流程图
'y2Q4g/x1[,[.yY02）有些操作手册里的图片是全屏截图的，尽量不要把任务栏截在图片里，51Testing软件测试网tKQ+_(C#C"B
3）操作手册里面的图片排列尽量统一，不要一个很靠左、一个居中，凹凸不平
'luD]5e X*K04）图片格式尽量用后缀.jpg
%@F9|lO!NXb07、明显错别字51Testing软件测试网`
Q&G8a2k2|
8、项目符号和编号不正确
m3r$a'J1]'F09、段落51Testing软件测试网!Qt bC1];y]
10、页眉和页脚问题
{7G]:\ee y!y01） 是需要根据文档名来命名页眉51Testing软件测试网,K5V7u,\3Q~0v
实际提交的操作手册和验收存在三种情况的页眉：
AgU6t5\Pk`X6u#j0一：XXX需求，页眉为：非此需求的－操作手册。
Et+{ VI L&z0二：XXX需求，无页眉，
j?3XT3DY0三：XXX需求，页眉为：操作手册或需求操作手册（重复名字）。

.@#c;MQnd0（待完善，请多提意见，谢谢）
)m"lZn d\-Av0