2更新字段其中一位_字段校验规范amp;字段库建立

前言

1.什么是字段校验规范&＃xff1f;

在表单填写上&＃xff0c;用户总是在与机器&＃xff08;平台&＃xff09;进行着交流。用户在输入前、输入中、输入后&＃xff0c;都需要平台的引导与反馈&＃xff0c;让其更加清晰顺利的进行整个操作流程。输入前的提示&＃xff08;前馈信息-feedforward&＃xff09;可以让用户理解这个字段&＃xff0c;帮助他思考如何去填写这个字段&＃xff1b;输入后的提示&＃xff08;反馈信息-feedback&＃xff09;是对用户操作的应答&＃xff0c;让用户知道他是否做对了这件事&＃xff0c;增强他继续进行操作的自信。下面一张图帮助你理解什么是字段校验。

2.字段校验规范表格的重要性

a.让交互稿更“单纯”

我们一般都会用交互稿来表示页面之间的逻辑关系、组件的交互方式、不同情况下的展示情况等。对于字段校验的限制条件、反馈方式&＃xff0c;我们也往往会在交互稿中标明。当表单页面中字段很多时&＃xff0c;就会出现复杂标记说明的情况。我们希望交互稿能够变得简单易懂&＃xff0c;能够更多的表示页面间的逻辑关系&＃xff0c;而不是复杂的标注&＃xff0c;重复的字段解释等等。

b.简化需求文档

页面中的字段内容基本都是产品经理定义的&＃xff0c;所以在 PRD 文档中会有大量关于字段内容及限制的描述。但往往需求文档是按照功能模块或是用户角色来划分描述需求的&＃xff0c;所以字段的相关内容也就会被放在不同的模块中进行描述。穿插在功能定义中的字段描述&＃xff0c;会让项目中其他成员在阅读时产生一定的困扰。而且如果字段发生变化&＃xff0c;需要产品经理去及时维护该文档&＃xff0c;开发也要时刻关注。

所以我们将产品中所有有关字段的内容都提取出来&＃xff0c;形成了字段校验规范表格。其中包括字段所在的位置、输入前的提示信息、校验规则、反馈时机、校验结果等内容&＃xff0c;这样可以很好的简化交互稿、需求文档&＃xff0c;同时也会让字段相关内容在查看时更加清晰。

在一年前我们做了相关的工作&＃xff0c;之前的内容主要是研究字段校验的一些规则、反馈的种类、提示方式等。

相关链接&＃xff1a;https://zhuanlan.zhihu.com/p/47588957

经过一年的使用&＃xff0c;我们发现了一些问题&＃xff0c;尤其在团队协作上和内容的复用上。所以我们将之前的内容进行雕琢&＃xff0c;更新了字段校验模板&＃xff0c;规范了团队中各角色的协同方式&＃xff0c;并且提出了新的提升团队效能的方法——字段库。下面将会给大家详细描述。

调研与问题

首先&＃xff0c;我们调研了公司各角色对字段校验规范表格的使用情况和感受&＃xff0c;下面是一些调研实录&＃xff1a;

产品&＃xff1a;

1.提示语有些不够明确&＃xff0c;希望能够清楚的告诉用户哪里错了&＃xff0c;怎么改

2.工作量有些大&＃xff0c;不是很想写

3.不太清楚规则&＃xff0c;一直按照自己的理解撰写文档

设计&＃xff1a;

1.大部分校验规则会写在交互稿里面&＃xff0c; 有些没办法描述的很详细&＃xff0c;交互稿也比较繁杂

2.各个项目间有很多通用的词汇&＃xff0c;很多校验规则其实是相同的&＃xff0c;可以复用

开发&＃xff1a;

1.有些表格内的描述不够明确&＃xff0c;比如对于数值的定义&＃xff0c;是否包含两端数据没有说明

2.如果没有定义字段规范&＃xff0c;那么很多字段的限制开发都是自己随便定义的&＃xff0c;测试也就凭感觉测试了。

测试&＃xff1a;

1.有一些提示是请输入正确的xxx&＃xff0c; 但是客户可能不知道怎么样才是正确的&＃xff0c;建议可以将字段输入要求告知客户

2.希望可以有版本追踪&＃xff0c;实时直观的了解到哪些字段进行了新增或修改

3.可以给出一些提示语的表述准则&＃xff0c;有利于平台字段规则的统一

根据以上的这些访谈结果&＃xff0c;我们可以总结出这样一些问题点&＃xff1a;

1.不太清楚字段校验表格如何使用、填写规则等&＃xff0c;在工作流程和撰写方法上没有明确定义&＃xff1b;

2.提示语表述的还不够专业不够准确&＃xff1b;

3.对于每个角色在团队中如何使用这份规范表格没有明确的定义&＃xff0c;大家的职责定位不清楚&＃xff0c;协同工作做得不够好&＃xff1b;

4.后期维护的过程没有记录&＃xff0c;导致修改时的混乱。

5.工作量有些大&＃xff0c;有些重复的字段信息还是在反复定义&＃xff0c;没有把复用性做好&＃xff1b;

针对以上的调研和结论&＃xff0c;我们推出了字段校验规范的「升级版」&＃xff0c;产出两部分内容&＃xff1a;

第一&＃xff0c;是字段校验规范模板的升级&＃xff0c;协作方式、编辑规则、后期维护等明确的定义&＃xff1b;

​第二&＃xff0c;是字段库的建立&＃xff0c;包含公共字段库和项目字段库&＃xff0c;以及协作的方式。

PART1 字段校验模板及其协作方法

1. 字段规范表格的填写说明

在上图中可以看到表格上每一个条目的填写规则&＃xff0c;在实际项目中&＃xff0c;已经通过详细的手册类文档&＃xff0c;将表格的撰写方式普及到产品开发中的各个角色&＃xff0c;便于他们之后具体的实施。有些列目的属性是有限的&＃xff0c;所以我们也都枚举出来&＃xff0c;以供填写人参考&＃xff0c;有些直接把表格设置成选择框&＃xff0c;从各种选择中选择即可&＃xff0c;例如&＃xff1a;

1.创建方式&＃xff1a;输入、选择、单选、多选、级联选择、只读、返显、系统自动生成、上传&＃xff08;基本包含所有创建方式&＃xff09;。

2.上下限&＃xff1a;字符数量上下限、文件大小上下限、数值大小上下限。&＃xff08;用【】或&＃xff08;&＃xff09;表示是否包含两端&＃xff09;如果是确定的字符数&＃xff0c;只写一个数字即可。

3. 支持格式&＃xff1a;字符的格式、文件上传的格式等。字符一般会有——汉字、字母、数字、符号之间的组合&＃xff1b;选择的字段可能会有日期、日期区间&＃xff1b;文件上传格式一般有——jpg 、jpeg、bmp、png、pdf、doc、rar、zip&＃xff1b;还可不限制字符格式&＃xff1b;如果是选择的话&＃xff0c;此处写的是选项内容&＃xff0c;用「 / 」分割不同的选项。

4.错误原因&＃xff1a;一般包含输入为空的校验、超过上下限的校验、不符合输入格式的校验、以及和系统相关的校验&＃xff08;是否在系统添加过等&＃xff09;。

5.校验时机&＃xff1a;失焦时校验、输入过程中校验、提交表单时校验&＃xff08;此处的提交表单指的是请求后端时校验&＃xff0c;有些表单按钮不只是提交&＃xff0c;有可能是保存&＃xff0c;确认等&＃xff0c;可根据具体产品更明确校验点&＃xff0c;例&＃xff1a;点击保存时校验&＃xff09;。

6.反馈方式&＃xff1a;字段下方出现错误提示、字段上方出现错误提示、字段左侧出现错误提示、字段右侧出现错误提示、toast提示、禁止输入不符合要求的内容、吃掉输入多余的内容、弹窗提示、其他相关字段受影响置灰、表单提交按钮置灰等 。

2. 字段规范表格的协作

​规范的执行需要团队的所有成员共同的努力。各成员的角色定位、协作方式、后期维护等问题&＃xff0c;只有定义清楚&＃xff0c;才能形成更好的工作流程&＃xff0c;让各成员更好的配合。

a.职责定位

b.工作流程

c.后期维护

上面讲述的关于字段规范的表格模板及其协作方法、工作流程的定义已经能够解决我们之前调研总结出的大部分问题&＃xff1a;

问题1&＃xff1a;不太清楚字段校验表格如何使用、填写规则等&＃xff0c;在工作流程和撰写方法上没有明确定义。解决1&＃xff1a;给出了详细的表格填写说明&＃xff0c;并对一些可能包含有限情况的表格做了选项处理&＃xff0c;尽可能的将所有可能包含在内。

问题2&＃xff1a;提示语表述的还不够专业不够准确。解决2&＃xff1a;在表格中我们给出了推荐的提示表述方式&＃xff0c;并且会在后期继续扩充&＃xff0c;添加不同语气、情况的表述方法&＃xff0c;供大家参考。

问题3&＃xff1a;对于每个角色在团队中如何使用这份表格没有明确的定义&＃xff0c;大家的职责定位不清楚&＃xff0c;协同工作做得不够好。解决3&＃xff1a;我们制定了工作流程&＃xff0c;定义各角色的职责定位&＃xff0c;使其能更好的各司其职。

问题4&＃xff1a;后期维护的过程没有记录&＃xff0c;导致修改时的混乱。解决4&＃xff1a;后期的维护是一个动态的过程&＃xff0c;所以制定了维护时的工作流程&＃xff0c;让文档能够及时更新&＃xff0c;时刻保证准确性。

解决了这4大问题后 &＃xff0c;我们发现「工作量大&＃xff0c;反复定义重复字段」的问题&＃xff0c;仅仅用字段校验规范模板表格是很难解决的&＃xff0c;所以我们提出了「库」的概念&＃xff0c;推出了「字段库」的形态设计与协作方法。

PART2 字段库

1.什么是字段库

「字段库」顾名思义&＃xff0c;是一个包含大量字段的一个仓库。里面承载字段的相关信息&＃xff0c;包含&＃xff1a;字段的类别、字段的内容、创建方式、上下限、支持格式、参考来源与备注补充等&＃xff0c;如上面的动图所示。我们将字段库分为「公共字段库」和「项目字段库」&＃xff1a;

a.公共字段库

公共字段库是「字段字典」的概念&＃xff0c;其中会包含从公司所有项目收集而来的通用字段内容。在这个字段库中&＃xff0c;我们给出了较为科学的字段限制条件&＃xff0c;可参考的字段标题与创建方式&＃xff0c;在日后可能还会添加不同场景下的反馈方式、反馈语句。我们希望在这个库不断完善、不断更新后&＃xff0c;可以涵盖公司大部分字段内容的需求。在后期进行新项目时&＃xff0c;可以作为参考或是直接使用相关字段内容&＃xff0c;无需再去调研、搜索。

b.项目字段库

项目字段库是各个项目的小字典。因为在同一个项目里&＃xff0c;会出现一个字段多处使用的情况&＃xff0c;所以我们在各个项目中建立字段库可以将字段规则总结起来&＃xff0c;方便在复用时的查看和应用。并且项目库中的字段&＃xff0c;大多是从公共库中取过来的&＃xff0c;公共库也会将项目库中的字段进行归档&＃xff0c;所以在公共库的建立和维护上&＃xff0c;项目字段库也起了不可或缺的作用&＃xff0c;具体的工作流程会在后面进行介绍。

2.字段库的意义

a.规范化&＃xff0c;很重要

对于交互设计来说&＃xff0c;一致性是很重要的&＃xff0c;字段校验也包含在其中。在没有输出字段库之前&＃xff0c;各项目字段会有大量的重复&＃xff0c;虽然字段校验方式、字段限制条件会有微小的不同&＃xff0c;但其实确定的字段是有确定的规则的。所以字段库&＃xff0c;就是归档了尽量全的规则&＃xff0c;让公司所有产品的字段校验内容规范化&＃xff0c;这在保持产品体验一致性方面是很重要的。

b.可复用&＃xff0c;避免重复工作

建立字段库&＃xff0c;可以最大程度的将重复工作量降到最低。在新建项目时&＃xff0c;大量字段可能都是以前其他项目定义过的&＃xff0c;这时就可以在公共库中将这些字段找到&＃xff0c;把他们的限制条件、规则内容复制到新项目的字段校验表格中&＃xff0c;省去了重复定义这些字段的工作。在各项目中&＃xff0c;当有重复的字段需要添加时&＃xff0c;也可直接使用自己项目的字段库中相关的限制、校验规则&＃xff0c;简化了很多繁复冗余的工作。

3.字段库的建立与使用

第1步&＃xff1a;各项目设计负责人在自己的字段校验规范表格中建立一个新的 Sheet ——「XXX项目字段库」。

之后把项目内所有字段&＃xff08;具有限制条件的字段&＃xff0c;只读字段不包含在内&＃xff09;的字段标题、上下限、支持格式按照「类别」&＃xff08;类别是按照自己的理解来归类的&＃xff0c;类似于卡片分类法&＃xff09;归纳在「XXX项目字段库」Sheet 中&＃xff0c;相同的字段应有同样的限制条件。

第2步&＃xff1a;公共字段库负责人会对项目字段库的内容进行筛选审核&＃xff0c;把内容填充到公共字段库中。

第3步&＃xff1a;新建项目时&＃xff0c;需要建立字段校验规范。产品经理先根据需求决定需要哪些字段&＃xff0c;然后在公共库中进行查找相关字段的限制条件&＃xff0c;将项目的字段校验规范表格建立起来。如果项目有特有的或新增的字段&＃xff0c;需由产品经理自己定义。设计师拿到表格后&＃xff0c;填充好有关体验设计的部分&＃xff0c;建立自己的项目字段库&＃xff0c;给到公共字段库负责人&＃xff0c;负责人需将项目中特有的、有意义的内容&＃xff0c;补充到公共库中&＃xff0c;供以后使用。

第1步和第2步主要是字段库建立的方式&＃xff0c;第3步描述的是使用方法&＃xff0c;如下图所示&＃xff1a;

4.后期维护

当有项目内部字段更新时&＃xff0c;应在项目字段库中同步更改&＃xff0c;并用红色标注出修改点&＃xff0c;并告知公共字段库的负责人&＃xff0c;公共字段库的负责人审核过后&＃xff0c;更新到公共字段库中。我们也会把各项目的文档在我们的协同办公应用中同步更新。

5.使用原则

a.为了保证公共库的准确性&＃xff0c;除去公共字段库的管理员外&＃xff0c;其他人不可以修改公共字段库内的限制条件&＃xff0c;只能在自己的项目字段库中做修改。

b.项目库中字段&＃xff0c;如果在公共字段库中有定义&＃xff0c;原则上应尽量使用公共字段库中的建议限制条件。因为公共字段库是经过调研确定过的较为准确的标准&＃xff0c;如果自己定义可能会不准确。

c.公共字段库会尽量收录各项目的所有字段&＃xff0c;并且在收录后尽量不做限制条件的更改。

写在最后

我们一直在努力深入设计、规范内容、简化工作。此次流程优化不仅是模板的设计、库的建立&＃xff0c;更是协作规则的定义。

因为随着项目的进行&＃xff0c;这些内容都会动态的变化&＃xff0c;所以需要各个成员的支持&＃xff0c;更需要不断地维护更新。

除去字段库的建立外&＃xff0c;我们还建立了icon库、素材库等更多提升团队效能的方法&＃xff0c;请大家继续关注&＃xff01;