编辑导读：交互说明文档，是交互设计师的输出物中必不行少的一项，它干系着设计方案可否最洪流平的被实现。本文作者依据事情中项目实践的所思所想，并团结案例平分享了写交互说明时需要留意的一些问题，但愿对你有用。

交互说明，是交互设计师必不行少的‘写作本领’，它能让研发同事越发相识你的方案说明、交互想法。

但写得欠好，容易呈现流水账式、逻辑不清楚、文案臃肿等环境，给本身带来特另外事情量，还影响着与研发同事的对接效率。

所以本日想总结小我私家对‘交互说明’这块的常识，让你和研发同事越发愉快地玩耍~

目次：

技能型交互说明

只写最重要的

它只是个‘黑板报’

按模块来展示说明

成立交互说明库

真实的数据展示

巨大说明别的展示

有变动时实时奉告

好的心态

01 技能型交互说明

传统的交互说明，是按照本身的意识、主观想法举办描写，但由于每小我私家的文笔差异、思维 *** 纷歧样，容易呈现出格混乱的说明，相关同事看了暗示压力山大想拔刀…

其实我们可以操作开拓熟悉的技能术语、代码逻辑来叙述交互说明，使开拓对交互说明有越发直观的领略，好比if else逻辑、switch case逻辑、数据库标识字段。

1. if else

一种判定逻辑，按照判定条件正确与错误来执行对应的操纵。它可以更直观地表达逻辑干系，更利于开拓同事的领略。

好比用户登录的多逻辑说明，可以这么写：

2. switch case

一种选择逻辑，按照选择项执行对应的操纵。好比按照用户投入钞票的面值，抉择可选择的商品范例。

‘default’是容易疏忽的选项：匹配不存在时做的工作。

好比上面的例子，若是用户投了1元，可能投了一张纸怎么办？

这是就需要‘default’的处理惩罚了。

3. 用数据库标识字段

别的，一些‘动态参数’用数据库里的字段名称来标志也是一个不错的选择。

好比：‘用户’，在数据库里的储存字段是 #UserName#，用它来取代交互说明里的动态参数，可以晋升开拓的领略效率。

怎么知道每个字段对应数据库的表达?

接口文档：前端和靠山之间用来传输信息的文档，哪里既有数据库的表达，也有对应的中文描写。

注：以上例子来自-唐韧《产物司理必懂的技能那点事儿》

02 只写最重要的

密密麻麻的文字说明，是早期交互设计师较量常见的‘短处’。

一是列全所有说明，可以淘汰被diss‘思量不周到’的大概；二是间接证明本身的专业本领。

可是！交互说明究竟是要给人看的，会萃的文字谁看得下去？？

只会带来特另外阅读压力和极高的领略本钱，交互设计师修改起来也贫苦。

一俩个页面还好，多个页面都是这样的说明，开拓没约你‘一起去登山’就不错了。

所以小我私家发起，只针对有异常状态、非凡交互、分支流程、要害节点等非凡处所举办说明即可。

对付一些知识性、无异常点的处所就不消写了。

无出格需交接的处所，写了只会让开拓发生猜疑：这个处所是不是在非凡交互？

03 它只是个‘黑板报’

不要理想单凭一份交互说明，就能让开拓完全、正确大白你的想法，那险些是不行能的事。

在我看来，交互说明只是个和开拓转达内容的黑板报，一个相同东西。

想让开拓真正领略你的交互说明、方案逻辑等，照旧得基于黑板报上的内容，亲自与开拓相同对齐。这样才气确定方案的有效性、实现难度、是否有需要调解的内容等，让两边的想法保持对齐。

前期与开拓相同清楚了，后头交互说明可以起到一个‘回首、确定’的浸染。

而对齐的 *** 可以是交互评审会、工位口述、 *** 相同等。只要目标能让开拓领略你的交互稿，对齐形式可自主调解。

04 按模块来展示说明

这个‘模块’有2层意思：

一是雷同于‘内容组件’：对付反复性强、呈现频率高的内容，配置一个模板内容及说明即可。

对付反复呈现的处所，直接取代已往就行，可以或许大幅度淘汰交互设计师的事情量，开拓也利便领略。