如何写出易看的交互文档
在很早之前就意识到,交互文档能够“易看”是一门技术活,怎么让所有人看得懂、看得快、找得快,也是我一直探索的。借着部门需要梳理规范之际,我也有机会梳理一下我对这门技术的浅显看法~略略略~~
接我上篇文章,我们揪出“易看”这个词~~
何为易看
看得懂:逻辑关系清晰,文字措辞准确全面
看得快:布局规整清晰,内容简介干练
找得快:层析目录清晰,变更记录清晰,界面功能定位清晰
如何写一份易看的交互文档
首先,有一个清晰的目录,这棵目录树是你心里的一颗交互框架树,让你能够自查,也是一棵便于检索的树。以下示例:(我喜欢 axure 而少用 sketch 的原因就是,它有目录树)

然后,我们举例实操去啦~~~
文档封面和更新日志

1、更新日志:每次更新一定要有记录,其一为确保有记可追、其二为确保下游知悉、其三为确保落地走查、其四为确保文档可持续。(建议倒序,建议和方面放一起,这样第一眼就看到)
2、更新日志里的字段内容:
更新日期:便于追溯回忆
变更人:便于追责、资讯详情
联系方式:作为变更人的唯一标识~~哈哈哈哈哈
更新内容:记录变更内容,记录变更原因
查看页面:便于在目录树中尽快定位,找到变更点
文档基本规范说明

一些通用规范,提高效率、便于理解、便于扩展
交互通用规范

通用的组件规范,可提高交互效率,避免重复工作
交互原型

1、页面标题:字母+文字组合,字母作为唯一性,便于定位,文字代表界面功能,便于理解
2、背景换成灰色,因为界面是白色,这将易于区分
3、界面尽量使用黑白灰红,白色象征不重要、灰色象征一般重要、黑色象征重要、红色则是警告,这将既不影响 UI 设计,也能帮助 UI 了解页面关系、重要性

1、子界面标题:父字母+数字。便于定位、便于理解层级关系。(后期你会发现,你找开发沟通的时候,只要说一句 B1 界面,大家都可以立刻找到,很是方便)
2、一页只放一个功能的界面,这就便于扩展和检索,也降低了浏览难度
3、所有界面都放在一排,且间距相同,这将使交互文档看起来布局很整齐,且跳转关系看起来很清晰
4、所有规则都放在对应界面的下方,需要规则的地方标个小标签,这将使得规则比较汇总统一、便于查找

如果一个页面上菜单、模块比较多,你可以按照总分的形式,将所有菜单拆开到多个子页面下,在父页面上只标注跳转关系。

关于交互说明:
1、在【如何写一份易看的交互文档】中有一份【规则自查表】,帮助你去走查有没有什么缺失的规则
2、关于文字,应该遵循交互文档的“信达雅”规范
“信”:指忠实准确地传达内容;
“达”指内容通顺流畅;
“雅”指语言干练简介
3、一话四说:当某项交互规则很复杂的时候,首先思考这是合理的吗,尚若合理,再去为如何让他人理解做努力。规则描述+举例子+流程图+交互图示/动画 demo
好了,我讲完了,这些内容只是我个人的过往经验,仅起借鉴作用,根据你的环境,你可以制定自己的规范~~~~~写完之后一定要检查哦,包括语句是否通顺无误、流程是否闭环等等~~~接下来加油吧~~~~~~~~~~~~~~