亮剑云商城官方博客

vuePress-theme-reco 亮剑云    2020 - 2022
亮剑云商城官方博客
主页
分类
  • app
  • 服务保障
  • 常见问题
  • 行业前沿
  • 常用工具
  • 最佳实践
  • 更新公告
  • 工作日记
  • 价值观
  • 计划
标签
时间线
联系我们
  • 服务细则
  • 客户案例
  • 联系我们
author-avatar

亮剑云

55

文章

44

标签

主页
分类
  • app
  • 服务保障
  • 常见问题
  • 行业前沿
  • 常用工具
  • 最佳实践
  • 更新公告
  • 工作日记
  • 价值观
  • 计划
标签
时间线
联系我们
  • 服务细则
  • 客户案例
  • 联系我们

文档改造过程的一些感想

vuePress-theme-reco 亮剑云    2020 - 2022

文档改造过程的一些感想


亮剑云 2020-03-26 文档

今天一天改了几十份文档,发现以前写的文档大多都有贪大求全的毛病,导致文档的实用性大打折扣。

考虑周全看似观念多么正确的一个词,可确是一个大坑。

一篇文档考虑的情况太多,对大多数客户都无用的内容多了,也就把客户的注意力都浪费在这些无用内容上,导致他们看不到真正想要看的。

套用二八理论应该是这样的,一篇文档80%的内容可能都是无用或很少用到,客户真正想看的可能只是其中20%的内容。

今天除了删除无用和少用的内容外,另一个修改的重心我放在了统一内容结构上,也就是我最近日记中经常会提到的约定和规范。

约定和规范我们也可以从注意力管理的角度去理解。

合理的目录结构、约定俗成的内容导航和结构有助于客户快速锁定自己想要的内容,可以很好的解决无用内容分散注意力的问题。

以前我对约定和规范不够重视,导致自己写的东西,想要用的时候自己都找不到。

就像微信用了这么多年其实我都还不大会用,这两年才开始认真用微信的备注、标签和收藏功能。

以前加微信好友没注意备注和打标签,要找的时候可费劲了,有的时候还找不到人。

文档可以说是我们产品的生命力所在。

客户不怕用的过程中出问题,就怕出了问题找不到解决的办法。

拥有完善的产品文档也就意味着我们为所有想要跟我们合作的组织机构打开了大门。