【实践案例】文档工程师帮助业务避坑案例

众所周知参数类相关文档是技术性较强的文档参数如何写才能体现公司产品的优势又巧妙的避免技术实现的不足呢做为某大公司软件服务的文档顾问我接到上司的需求要求帮他新增一个性能实现的前提具体内容是原文在运营商通道稳定的情况下国内短信的可达率为99%最大时延15秒平均到达时间为7-8秒。领导要求新增电话号码有效的前提另需要对有效号码进行解释第一轮修改后在运营商通道稳定且号码有效的情况下国内短信的可达率为99%最大时延15秒平均到达时间为7-8秒。备注有效号码是指XXXX背景的领导对逻辑性要求极高要求我参阅阿里云的文档新增对可达率的解释。本能地觉得可达率这种显而易见的概念没必要解释且经再次查阅竞品文档果然发现竞品没有解释可达率另外还有一点重要发现其它竞品没有写最大时延和平均到达时间。于是我向上司建议1.为了保证文档简洁性配套文档不用解释可达率这种显而易见的概念2.避免自爆弱点删除最大时延15秒。3避免竞品调查提炼出较好服务性能表现改成秒级可达十秒以内都算秒级。4.观察到该文档下一个主题只用了80字这个主题用了150字。需要进一步提炼保留精华信息。第二轮修改后在运营商通道稳定且号码有效的情况下国内短信的可达率为99%秒级可达。备注有效号码是指XXXX【缩略版】总结以上案例笔杆子在撰写参数相关的技术文档要做到三点1.对业务相关的关键参数有深刻的理解这可以帮助我们在写作过程中抓住凸显业界领先也可以让我们避免对客户输出不太理想的参数。横向比较竞品在每个模块上的表现可以我们在面对突围时更有底气必要时要进行主题研究。2.信息简洁可读性可以帮助用户提升阅读体验降低文档的信噪比。与核心数据不相干的简单概念可以不写横向比较类似信息的体量做到横向一致性。3.技术文档不仅带有技术性也带有营销性保持商业思维让产品和服务更有吸引力。