美文网首页创建营商
职业病发作,从技术文档撰写角度看《得到品控手册》

职业病发作,从技术文档撰写角度看《得到品控手册》

作者: 小多媛媛 | 来源:发表于2017-05-23 22:32 被阅读85次

    今天,终于通过“得到”微信公众号,下载到了心心念念的《得到品控手册》。甫一到手,就迫不及待翻看起来。

    首先,必须要申明我个人是得到的忠实粉丝,每天几乎只要耳朵闲着,都会把时间都花在“得到”上。

    也非常感谢得到为各种长度的碎片化时间和学习提供不同形式和内容的选择。而且这一本手册对于后续的人执行同样的操作具有很强的指导作用。后续的人可以很大程度参考和引用其中的内容和思路。这些我会在后续陆续与大家分享。

    但是,出于用户和忠粉的角度,再加上职业病发作,我还是想先给得到品控手册挑挑刺。毕竟,既然宣称是品控手册,至少品质上也得能树个标杆不是。不过如下都是我个人意见,仅供大家一乐。

    首先,从用户阅读便捷性来看,做得不是特别好。通篇有很多大大小小的章节构成,将近200页,但是能够跳转的目录只有如下几个,没有下一级目录。

    缺少二级目录

    如果我想回看某个章节,就得用手指拼命往回划拉。

    第二,《产品操作手册》名不副实。因为实际讲的并不是产品的操作,而是产品的制作或运营。也就是说,这并不是一本operator manual,教用户如何使用。而更像是一本生产作业指导书,工艺文件,指导内容生产者如何生产。同时兼备流程和规范的作用,讲述如何进行质控。

    第三,平行的章节之间架构差异比较大

    仍然以《产品操作手册》举例,本章包括若干产品的制作规范,如“订阅专栏”,“每天听本书”。作为平行的章节按说它们至少应该在大的框架上保持一致,如包含概述,人力&职责,操作规范等等。到目前看来并非如此,不过也可能是得到自身特色?

    如下所示一个大章节,与其平行的内容都包含1,2,3。而这里却直接在主标题(文章标题)下就是2.1。

    没有1,没有2,直接就有2.1

    另外,平行章节内容体量差别太大,颗粒度不均匀。有的二级标题下面内容多达两三页,有的只有一两句话,显得头重脚轻。

    第四,没有采用更为直观的展现形式

    如下的一个逐步递进的判断,可以用逻辑流程图直观展现。

    建议使用逻辑流程图

    如下的内容则可以选择表格加流程节点,列明任务类型,时间节点,责任人,通过条件即可。

    建议使用表格

    第五,语言拖沓,标点使用不规范

    多处存在标点不规范问题,如下:

    句末建议使用逗号

    第六,语气风格问题

    通篇很多都在说不该如何做,这在操作手册中不提倡。

    建议多使用主动句,祈使句,避免使用被动句,否定句。

    如上例的第四句,“不要骗我”,建议改为“图文一致,不做标题党”。

    此外,还有很多的大长句,让读者难以判断逻辑关系。

    语意不清晰

    看了好久,我还是没看明白,运营需求与交替校稿的关系。而内容需求和错别字、弹窗又是什么关系。建议拆分,不要为了省字表意不清。

    第八,缺少必要的参考信息

    文中提到的很多信息,应该不是得到独创,而是援引法律法规。但是没有在合适位置注明出处。这一方面不符合写作规范,有侵权危险。同时会削减内容的可信程度。一句话,如果是直接从法律法规中扒拉出来的,看起来可信度就高多了。

    没列明具体的参考文献

    凑齐了吉祥的八点,可以安心睡觉了。

    我应该算是善意引用,不算是曲解或者修改吧?

    最后再次推荐得到APP。

    注:来源,《得到品控手册》。

    相关文章

      网友评论

        本文标题:职业病发作,从技术文档撰写角度看《得到品控手册》

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