14 | 怎么写好用户指南？
范学雷
该思维导图由 AI 生成，仅供参考
前一段时间，我要买一部家用的跑步机。有一款跑步机看起来配置齐备，商品的标题中指明“需要组装”。
商品的评论只有两条。其中一条给了三分：“还没有来得及试一试这个新到的跑步机。因为，我一直试着把它组装起来。我做梦都没有想到，‘需要组装’意味着我花了三天时间，都没有组装起来。它也许是一个好的跑步机，可是令人失望的是，这些零件到底该怎么凑在一起！”
而另一条则给了最低的一分。评论写道：“商品描述不准确。这台机器非常重，长度甚至超过两人沙发。一般的家庭根本放不下这台跑步机。已经退货了”。
你可以想象，这两条仅有的评论对这款跑步机的销售有多大的杀伤力。它本身的品质无论如何，都不至于沦落到一分、三分的地步。
问题在哪儿呢？无论是谁，花了三天时间都搞不定组装，肯定有一肚子的不满意。好不容易组装起来，却发现没有空间放置，又要拆掉退货，就会更不满意。
我了解了一下这款跑步机的用户手册，发现组装非常繁琐，所涉及的部件有很多，还真不是一下子就可以搞定的。
很显然，用户指南非常重要，但这款跑步机却给我们提供了一个反面的案例，可见写出一份好的用户指南也不是一件容易的事。
最好的用户指南，是产品本身。我们随手拿一只圆珠笔，就知道怎么用。然而，不是所有的产品都能够简单到拿来就用。一份合格的用户指南，要帮助用户减少产品使用的障碍，快速地使用产品。
公开
同步至部落
取消
完成
0/2000
荧光笔
直线
曲线笔记
复制
AI
- 深入了解
- 翻译
- 解释
- 总结
本文讨论了开发指南的重要性和实践方法。作者通过购买跑步机的经历引出了用户指南的重要性，并强调了用户指南对产品销售的影响。开发指南和接口规范的分工，以及开发指南的三个规则：交代清楚概念、快速上手、示例可操作。文章强调了开发指南需要从用户角度出发，容易上手，并需要维护。最后，作者提出了两个真实例子供读者练习，并欢迎读者分享建议。整体而言，本文强调了开发指南的重要性和实践方法，为软件开发者提供了有益的指导。
仅可试看部分内容，如需阅读全部内容，请付费购买文章所属专栏
《代码精进之路》，新⼈⾸单¥59
《代码精进之路》，新⼈⾸单¥59
立即购买
© 版权归极客邦科技所有，未经许可不得传播售卖。 页面已增加防盗追踪，如有侵权极客邦将依法追究其法律责任。
登录 后留言
全部留言(12)
- 最新
- 精选
北风一叶我之前的主管给我的建议是这样的：你就把用户假定为啥也不理解然后再去写文档，写出来的文档就是合格的作者回复: 这是一个好办法。经常地，我们看一些文档，觉得废话太多，大量的篇幅交代背景。其实，哪是为了照顾更多的用户。
2019-03-1110- kelvin我提出要给服务的接口写wiki，但是领导说大家都不会维护，还不如直接问接口维护人。我觉得维护文档是大家不太习惯，但是长远来看是可以提高开发效率。
作者回复: 直接问接口维护人的问题很多： 接口维护人不一定时刻都在；接口维护人不一定有那么多时间；接口维护人不一定记得那么多细节；我们不一定想要面对面地提问；面对面问问题的效率有可能更低（复杂的技术问题需要问答双方都花很多时间）。
2019-04-033 
第一装甲集群司令克莱斯特说难听点，用户是'愚蠢'的，他🚪甚至能测出来你想不到的bug，所以要提高产品质量和易用性，还有测试的充分性。作者回复: ;-) 他们还能测试出我们自己测试不出来的bug.
2021-08-041
空知微信和Github的示例都只是提供示例,但是一些前提概念没有说明下吧.作者回复: 嗯，引用的是快速入门部分。
2019-02-151
Lindroid今年我也在GitHub上添加了两三个开源库（主要是供自己使用），不得不说写好说明文档真的是不容易的，而且比起最初的编写，后期的维护也考验人。作者回复: 😊经久耐用的软件，成本基本都在维护上。
2019-04-27
秦凯个人理解是：接口规范应该更多的是描述接口为什么这么设计，而用户指南更多的是指导用户如何使用接口，阅读的群体和功能上有区别。作者回复: 在 Java SE里，接口规范一般不包括“为什么这么设计”的描述。
2019-02-15
stars有些做产品的味道了。2023-06-07归属地：陕西
ifelse
事实上，用户指南，不能超越用户的理解能力和操作能力。--记下来2022-07-20
进化菌
用户指南，目的在于引导方向。写好用户指南，不仅是给产品做好说明，并且可以为后来者减少麻烦~2021-11-22
丁丁历险记身为py coder 我内心纠结之处，一直觉得java 反人类，经常一个简单事搞的啰哩巴嗦的，一度认为再好的设计模式也救不了java 的不优雅。 甚至看到java 的代码示例看着就浅意识排斥。 现在技术到了瓶颈期，在反思如何改善这些观点，我可以不喜欢，但个人鲁棒性需要加强。2019-10-141
收起评论
