正式开始阅读前,我必须要告知读者友们,此是我工作来的一些经验总结和对工具的使体验,代表这就是交互文档的写作范式。交互文档可以根据自己公司团队的需求行归纳,我这里仅分享一下我的验。
Axure 和蓝湖是我平工作中最的两个软件,一个是设计生产工具,一个是在线协同工具,两者搭配干累。
本分为两分,第一分是分享我个人在工作中如何 Axure 制作交互档,第二分是如何蓝湖与产经、视觉设计师、客户,及营等他人协同。本基于个人有限的工作经验和知识积累,若有足之处,敬请指,互相习交流。
1. 分清产品需求的层级,部分更新和正式产品
撰写文档的时候,应该知道此次的需求一完整的项目,还对已项目的完善优化。如果一新的项目,那需文档中描述产品介绍,并且用简短的语句描述出产品功能目标用户。但如果新优化,则只需描述项目称新的功能概就好。
2. 交互文档的要素
文档说明(版本说明、使用平台)
文档说明是相于文档封,文档说明应该简短介绍该文档涉及品、平台、版本以及参与员。
更新日志
更新志是文档中必不少的部分,更新志包含一个项目从一个版开始,到截止开上的最一个版的概要,方便自己和其他协人能快速找到优化的部分,在哪一次的文档中增加、删除或者优化的。
制作的更新日志页面,包含以下个基本要素:
- 时间:时间是指该文档经优化以,上传至协平台(比蓝湖)的时间,以明确文档变更的具时间。
- 更新内容:更新内容是指将文档变更的功能点一一列出,别用文字作简的描述,更新内容是更新日志中非常重要的一环,如果没有文字的说,那回溯文档版本的候,就没法进行快速地检查和浏览了,对于后期维护将是一灾难。
- 更新页:更新页是指将更新内容分应不交互页,有助于开发或者其他小伙伴快速准确找到更新内容。开发没时翻阅大量文档,此版本更新需要告诉他们哪里改变了即可。
- 新类型:新类型分三种,新增、删除、优化。我将每一次的版本新打不同的标签,该标签可以加直观的明当版本新的类型新增还优化。
另可以根据自己需求增加改、版本号等要素,由于在实项目,有我个在维护文档,再加上做 SaaS 版本规划不是很明确,我文档不涉及这两。
阅前须知
阅前须知是指文档的使用者在阅读之前应该要浏览的注事项,否则无法理解文档中的一些殊示。
阅前须知我分为:用标识说明和用组件说明。
通用标识明,指整文档中广泛存的标识元素行明,帮阅读者速了解文档的专用标识语。
通用组件明,指发一全新的产品时,建立的一套简化版的设规范,该设规范指了当文档中一些组件的样式、交互以及特殊况。
结构图、流程图、思维导图
结构图,一般我文档全部新完毕传的时候,会用 Axure 的流程图功能将全部的页面一树形的结构图。点击结构图中的模块可以很方便跳转至相应的页面,这样发查看文档的时候不用一去翻阅文档,可以直接打文档结构页面,整文档的结构一目了然,点击模块就可以直接跳转至相应的页面,方便又速。
流程图,指业务相关的流程图,将业务逻辑用流程图行描述,一般对于复杂业务。流程图不但利于自己构建完善的业务流程,同时也利于发梳理业务的逻辑。
思维导图根据文档的需将产品的功能,用思维导图的形式罗列出,发可以穷尽每一类目下面的子级,从获得一完整的结构。
以三种都辅文档使用者撰写者理解文档的图示,因此非必须的,可以根据业务的需求行绘制相关的图示。Axure 本身对流程图思维导图很好的支持,因此只需第三方软件好图以后,复制到 Axure 界面即可。
交互页面
交互页面整文档中重的一部分了,也整文档的主体、每行业每产品的交互文档都不一样,尽各不同,但也能总结一些通用的规范。
档结构要清晰合:交互档的层级划分清晰明确,通过产的结构进行页面的划分,分清页面的次。
词准确且无歧义:首先,在对档进行描述的时候,词一定要准确无歧义,如果专术语解释清楚,可在后面举个例子。档的目的是阅读的人看懂,无论他是开发还是产,因此通俗的语言描述你的档,适当的时候举例子进行补充说明。
其次,你的文档对应的产品目标用户,是否能理你的描述也很重要。举个例子,在台产品中,使用者并不一定是识水平非常高的人,果你用「阈值」等业术语并不加释的,用户很难去理产品的功能。
流程完善且无缺漏:一般来说,互文档在付的时总因为各种原因而有所遗漏,要么是因为不熟悉业务而导致部分功能没有涉及到,要么是因为不技术而缺失某特殊场。在个时,我们需要通互走查和评审来现相关的问题,走查是撰写者自己对照走查表梳理页面的缺漏,评审则是通他人的角度来现问题,因此一个的流程是不断迭代和完善的,你需要做的就是尽能将互文档做得完善且无缺漏。
文档模拟数据尽量还原数据:很人在设计的时,填充大量的模拟数据用以支撑页面的内容。sketch 有很自动填充的插件,比头像、图、文、姓名甚至是地址等,样的插件方便我们的工,但是有时文的填充并不贴合我们的业务,甚至能完无关。但是 Axure 没有样的插件,因此在设计的时,我们尽量去还原的场,比品名称,就写的品名称,地址就写的地址,果你填充的是毫无逻辑的文,么阅读者在主观上很难融产品的使用场。
当,每条数据用不同的文填充将耗费我们大量的时间,你也以采取一比讨巧的方式,比,一个列表,一行用文,其余的复一行的即,但是果涉及到不同的状态,还是要加以区分并说明。
极限情况和缺状要注:多新可能经常会被开发问:「这个文本框字符最多可以填多少个?」这是由于对极限值没有在文档中进行说而造成的疑问,除了指定「最多」情况,也需要指定「最少」的情况。
那问题来了,该如何去判断用户应该输入的字符范围呢?首先,这是由个因素决定的。
第个素,所输入段,在用业务场景下,般都是多少个符。比如商品名称,我们可以去查看下淘宝等平台商品名称,再结合我们业务进段限制。
第二因素,所输入的字段,的业务场景下,显示什么区域,该区域允许显示的字符多少。如果的台列表页中只给该字段预留了一行,那么应该视觉判断下致需显示的字符数,如果只能显示一行,那么就设截断规则,一般都用「…」替,点详页的时候显示全部的字符。
类似的极限情况太多了,如断情况、流程中断、数量范围等,务、场景同,极限情况同,在这里就一一枚举了。
另一个需要注意的就是缺省状态,即默认状态。我们在设计界面的时,是在设计一个页面内容满载的状态,而非一个产品的初始状态。果设计初始状态,么我们的设计稿就一空白,因此我们在设计完产品的时,也需要梳理下页面的缺省状态,比个人中心的订单没有订单的情况,台品列表中没有品的情况,以及查询为空的状态等。
文档标注需要清晰且确:在交互文档中,除了交互页面的计,其中最重要的就是标注说了,大一部的操作交互除了直观的界面展示以外,就是通过标注说来阐释的。在的工作流程中,将其为了四个类型:全局说、带标记线的说、局部说以及交互说,别是针对整个页面的说、带有视觉引导的说、局部功能的提示性说以及操作说。可以使开发能够迅速准确的定位并理解标注内容。
第三视角文档:把当成该文档的使用者,把当成该产品的用户,把当成该文档的审核人,通过这个角度,你会哪些地方用语不确,逻辑有些混乱。在对页面进行穷尽式梳理的候,尽量别偷懒,把你能想的情况都一一说。
文档附件
互文档存在的意义是将产品需求用视化的框图展示给相关人,因此需要辅助的文档来完善整个文档的功能。文档附件包括且不导出字段的表、上传的表、产品需求表,以及用其他软件的辅助文档等。通常承载 Excel 表、Word 文档、PDF 文档以及图等文件中。由 Axure 中并没有以直接上传其他文件类型(除图和文字)的功能,因此我们通常用云端协软件来上传,比蓝湖的资源库功能。通常,要在文档中需要的页面添加相关说明,表示有相关文档附件的存在。
收功
收是指需求变或者他原因导致你做的组件和页面上了,需要将整个优或者删掉,但是除后又会改来,你只需要将你的组件或者页面放到收,标记好相应的名称(为了方次查询),如后需要可直接复制到相应的页面。
交互走查表
建立交互走查表首先需要熟悉产务逻辑,走查表是建立在产功之上,每个产的交互走查表都一样。中,平台的差异是较大的,如,移端 app 和 web 平台的差异性导致了页面实现的逻辑一致,因此容易遗漏的点一致。web 端是基于浏览器的实现逻辑,而 app 则需要根据每个平台的差异(iOS和卓),建立同的走查表,但是这只是针对平台规范的走查,要的务逻辑的走查都是相通的。
基础逻辑走查:
业务逻辑走查:
建立走查表是一个不断完善迭代的程,只要不偷懒,一般建立一个很的规避措施。
3. 其他问题
设计组件的整和制作
在开始一个项目之前,如果是一个全的项目,那我建议你为这个项目打一个组件库,或许这将你很多时间,但是在后续设计的时候你将会感受到它的利性。同时,建立好规范的组件库后,你无需时时查看尺寸大小等细节规范,只需要将拖到界面合适的位置,改即可,这样既保持了整个档的统一性,又设计档的效率。
另外,果你的产品有自己的一套设计系,但是并没有做成组件,我建议还是做成一套组件引到自己的 Axure 中,将在续的更新和护上给你带来巨大的便。
同,你也可以使用第三方的计组件,比如蚂蚁金服推出的 Ant Design。
高保真、低保真该选哪个?
有些视觉出身的交互设计师能纠结互文档是否要做的跟设计稿一样,增加很的互操和动态效果。关高和低该选哪个,唯一的参照依据就是,你的互文档使用场是什么,目标用户是谁。
如果你的使用景是在公内部开发使用,目标用户是和你作的前后端开发人员以及产品、UI,那你的文档是为了提高开发效率而存在的,这你不需要做成跟视觉稿一的,你只需要用黑灰的线框图做好产品的型即可,这做的好有四个:
- 设计效率极高,能快速完成产品原型设计;
- 修改方便,在型阶段,交互稿的改动是非常频繁的,因此如果你做的跟视觉稿一,加了多交互操作,那改动简直会要了计的命;
- 适合开发抛开细节快速查看,页有很多 UI 元素时候,会影响开发(后端)梳理逻辑,为这些细节会误导他,更何况 UI 界元素本身是多变不确定,开发在开始时需要梳理业务逻辑即可。至于 UI,那是视觉设计稿和前端事,在交互阶段并不存在这个问题;
- 可以让 UI 充分发挥自己的设感,设出加出彩的界面。我们作交互设师,只需关注页面的交互业务的逻辑,无需关元素的圆角阴影的小。如果的交互稿的 UI 视觉稿一样,会主观影响 UI 设师的判断,甚至可能会引发同事之间的矛盾。
如你使用场景是项目演示,目标用户是没有软件开发相关知识板、(客户)、测试用户,你需要根据你们自己需求,立套可击、可跳转高保真原型 demo,用以在项目演示时候客户或板进演示操作,他们个观生动印象。如他们拥有绝大部分决策权,会有很大几率过案。
因此,关于高保真低保真的争论必,选择哪一完全看交互原型的使用场景目标用户。就我人讲,一般作场景下,我不建议将交互文档视觉稿的。
1. Axure上传至蓝湖,建立好文档
在蓝湖立好相应项目,入相关参与,用蓝湖软件将 Axure 文档接上传至蓝湖平台,过其他讯软件告知参与各,文档已上传。
2. 将附件文档上传至资源库
若你的交互文档有附带的其类型的文档,可以上传至资源库,并在交互文档的相关页面进行说。
3. 查看历史版功能
开人在查看的时以点击相关的历史版进行对比查看,也以快速跳转至文档改动的页面。
4. 交互档联设计稿
如果你的设计稿和交互档的页面了同一个名称,蓝湖会自将你的设计稿和交互稿联在一起,可直接从交互稿跳转至相应的设计稿,这对于前端开发来说,非方。但是目前没有手联的功,大多数情况,自联并是很好,只说是一个有甚于无的鸡肋功了,希望后续手联。
团队内部人员协同,标记并通知
如果需特别强调某功能,可以直接原型中添加论并@参与人员。蓝的标注功能已很好用了,但唯一的缺憾,如果改动,我无法一软件中同时完修改页面修改明的操作,因此如果 Axure 中修改了页面,再去修改蓝中的标注明,对我效率太低了,因此我的标注明都当页面中,既方便导出使用,也方便线协作。
用链接密码分享文件原型
如你项目需要第三看,他并不想注册蓝湖账号,比如、客户、参与测试用户等,你可以将链接和密码发相关员,便高效。
此文这就告一段落,当然一交互文档不仅仅包含这些内容,根据不同的需求和业景,交互文档的范式也不一而足。因此,总结出适以及适队使用的交互文档是协同的最佳方式。
在我个看来,交互文档虽然在规范化上临着挑战,即怎样才能输出让他易于理解文档,最要是,如何在业务需求基础上输出合理解决案,成业务需求和技术实现平衡。
欢迎关注作者的微信公众:「星野随记」