文档书写之字段说明

显示类字段

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

录入型字段说明

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

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

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

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

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

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

混合型

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

权限控制

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 14,029评论 6 13
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 176,323评论 25 709
  • 小学一二年级时,同班有一个女孩,长得好看,家境又不错,老师同学都很喜欢她。当时的我非常羡慕她,觉得她就是我理想中的...
    简单的蜗牛阅读 3,619评论 0 1
  • 【麦田儿童工作室温馨提示】 从今天起,我给大家推荐或赏析绘本,不单单从绘本的优劣来分析,更会从孩子该年龄段的心理特...
    耘心人阅读 3,547评论 0 1
  • 每个人都有自己不愿回忆不愿提起的往事,或许我不该触碰,那些本以为能轻轻松松随口说出来的旧事,最终也只是本以为,还是...
    斯镇集市阅读 1,432评论 0 1

友情链接更多精彩内容