文档书写之字段说明

作者: xunzou | 来源:发表于2017-08-31 14:18 被阅读32次

显示类字段

  1. 数据来源:需要一些容易引起歧义的字段,例如订单时间,这个定义是:下单时间?支付时间?还是其他?这个需要进行明确
  2. 数据校验:必填还是选填,如果是选填,那么前台是否提前需要提示,以区分查询失败的情况
  3. 数据类型:字母、数字、中文、图片(各类图片格式)、语音和文字等等,如果可能是多种类型的组合,需要提前说明,避免显示的兼容性出现问题;
  4. 数据长度:最长最短长度,保证页面可视效果的兼容性;
  5. 后续冗余:在可预见的范围内,字段后续可能还有哪些扩展,如果提前做好兼容,就避免了后续字段更改,同步上线的麻烦。

录入型字段说明

  1. 数据来源:手动录入/系统获取。假如系统中有多个同义的字段,需要明确取哪个字段;

  2. 数据长度:最长最短长度,例如【0,20】;

  3. 数据校验:必填/非必填,是否为空;

  4. 数据类型:字母、数字、中文、图片(各类图片格式)、语音和文字等等,如果可能是多种类型的组合,需要提前说明,避免显示的兼容性出现问题;

  5. 数据合法性校验:一方面需要明确校验的规则,另一方面需要明确校验的触发条件,是输入达到特定长度(例如汽车VIN码就是固定17,输入位数达17位可以自动发起搜索),光标移出文本框,点击提交按钮?

  6. 后续冗余:在可预见的范围内,字段后续可能还有哪些扩展,如果提前做好兼容,就避免了后续字段更改,同步上线的麻烦。

混合型

字段先回显,然后再编辑,就是上述的组合,就不在赘述

权限控制

不同角色能够看到的和能够操作的数据是不一样的,这部分更多的是归属权限控制部分,详见后台权限设计总结

相关文章

  • 文档书写之字段说明

    显示类字段 数据来源:需要一些容易引起歧义的字段,例如订单时间,这个定义是:下单时间?支付时间?还是其他?这个需要...

  • Swagger字段说明

    常用字段说明 @SWG\Parameter常用字段说明 传送门 swagger官方文档swagger从入门到精通

  • values(),values_list() flat

    values(),values_list() 都是得到当前对象的所有字段或者指定字段的值。 官方文档说明:http...

  • postman参数为Json数据结构

    本文主要postman字段为Json结构时的操作说明 本文以订单发货为例,根据接口文档去设计 用户下单接口字段如图...

  • Hive添加或删除字段

    官方文档关于Add/ReplaceColumns操作的说明 原有数据在新增一个或多个字段后,会将新增字段的值设置为...

  • php-fpm原理

    FastCGI是什么?它是一种协议,所以它是一种文档,文档中说明了交互方式,交互的字段等等信息。FastCGI不是...

  • 查询API

    1. 修改文档字段信息 : 下边的例子修改doc_id = 2 的文档的两个字段 2. 查询文档的某些字段: 下边...

  • elasticsearch cat api

    健康: 文档 count: 文档 索引:文档 节点:文档 cluster:文档 分片:文档(需要注意state字段)

  • MongoDB Aggregation聚合操作之$unwind

    一、$unwind介绍 解析输入文档中的数组字段,为每个元素输出一个文档。每个输出文档都是输入文档,数组字段的值被...

  • MongoDB查询条件-数组操作符 --- 2022-04-03

    本章节,介绍MongoDB关于JSON文档中的数组字段的匹配操作符。 MongoDB支持的数组查询条件 操作符说明...

网友评论

    本文标题:文档书写之字段说明

    本文链接:https://www.haomeiwen.com/subject/xccqjxtx.html