如何写好一份技术文档

1.参考尼尔森十大交互原则

2.参考交互设计7大定律

语义一致原则

原理:

大脑适应不同名词需要耗费时间,通过减少切换开销来提升阅读效率

常规示例:

内容1:麦克风阵列的圆周半径推荐35mm

内容2:麦克风阵列可选直径为60~80mm

改进示例:

将直径统一成半径,保持语义一致

内容1:麦克风阵列的圆周半径推荐35mm

内容2:麦克风阵列可选半径为30~40mm


流程最短原则

原理:

减少用户的切换成本,所见即所得

常规示例:

改进示例:

将网盘链接修改为下载链接,减少操作流程

图文结合

原理:

基于情景,小白用户按流程操作,无需做文字与图片的转换

常规示例:

首先打开文件-->点击导出为-->点击本地excel表格(.xlse)

改进示例:

最少冗余原则

原理:

人脑处理速率有限,尽可能降低大脑的信息负担

常规示例:

改进示例:

去掉了冗余信息

主线突出原则

原理:

文档要覆盖多数人的需求,少数异常过程通过链接引出

常规示例:


改进示例:


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容