美文网首页
如何写好一份技术文档

如何写好一份技术文档

作者: 贺思源_e355 | 来源:发表于2019-07-18 10:28 被阅读0次

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

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

语义一致原则

原理:

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

常规示例:

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

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

改进示例:

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

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

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

流程最短原则

原理:

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

常规示例:

改进示例:

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

图文结合

原理:

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

常规示例:

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

改进示例:

最少冗余原则

原理:

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

常规示例:

改进示例:

去掉了冗余信息

主线突出原则

原理:

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

常规示例:

改进示例:

相关文章

  • 如何写好一份技术简历?

    如何写好一份技术简历? 如何写好一份技术简历?

  • 如何写好一份技术文档

    1.参考尼尔森十大交互原则 2.参考交互设计7大定律 语义一致原则 原理: 大脑适应不同名词需要耗费时间,通过减少...

  • 5.3 原型设计 - 需求文档

    需求文档,产品经理最终产出的文档,也是产品设计最终的表述形式。本次分享呢,就是介绍如何写好一份需求文档。 1. 什...

  • 需求设计

    1. 如何写好一份产品需求文档 功能性: (1)头部:相关信息、版本修订记录(每...

  • 产品之路-基础文章

    怎么用Axure写产品需求文档基础教程如何书写好的产品需求文档PRD如何快速写好基于AxureRP原型的PRD文档

  • 如何写好一份设计文档

    一份设计文档的结构大概可以分成Background项目背景、Schedule排期、History版本历史记录、In...

  • 如何写好一份需求文档

    作为一名合格的产品经理我们都要学会输出一个需求文档。我是将需求文档和产品文档进行了区分。这里的需求文档他们之间的区...

  • 如何写好一份PRD文档

    本文档只讨论一件事情,如何才能写好PRD文档 PRD文档是产品每天工作中必须撰写的文档,能够写出好文档成为一个PM...

  • 程序员如何写好技术文档

    互联网发展很快,以前程序员一个人能干的活现在慢慢的被细分成多人协作,常见的职位有UI、UE、产品、前端、测试、后端...

  • 如何写出一份好的产品文档

    产品文档是每一个产品人员都必然要产出的东西,也是一个重要且频率很高的产出。那么如何写好一份产品文档?怎么算好?上午...

网友评论

      本文标题:如何写好一份技术文档

      本文链接:https://www.haomeiwen.com/subject/qpeklctx.html