问答：机器捉虫，提升文档质量 | 技术传播

前段时间有位张童鞋，通过TC圈子的微信群找到我，想要为自己的研究课题做一个调研。

问题1：结合您的实际工作经验，您在技术文档写作时，是否有使用工具自动化检查文档质量果有的话，请问相应的软件是什么体的使用流程是怎样的/strong>

个人认为，一般较大规模的公司，才有可能会在技术文档开发过程引入自动化检查文档质量，以期提高生产效率和文档质量；而对于中小规模的公司，主要还是倚赖开发者自行把控文档质量。

之前曾经在某厂接触过（但不是很多）自动化检查工具，不确定是否是成熟的商业软件人感觉比较像是内部的自研工具。

具体的使用流程是：将工具嵌入文档发布环境，随每日文档例行发布，执行自动化检查。文档发布后，同时生成相应错误报告，即可跟踪团队每日工作引入的错误；发布前也需要进行自动化检查，确认文档错误已经被全部解决。

问题2：在具体的写作时，您遇到的技术文档的错误类型都有哪些/strong>

没有特别对错误进行分类，单纯列举一些想到的：

• 低级错误，包括但不限于错别字、乱码、病句、标点符号误用、多余空格/空行；

• 内容一致性问题，包括但不限于术语、基本句式；

• 图文内容不一致。例如，UI界面上显示的文本，与操作说明存在差异；

• 风格样式不一致；

• 断链接；

• 模板误用。例如，多语言场景下，手册未正确引用适配当地的版权页模板。

• 写作规范要求未满足。

问题3：您现在使用的工具能否很好地检验这些错误果不能的话，您认为自动化检查工具还应该覆盖的错误检查类型有哪些/strong>

通常自动化检查工具也只能检验部分可以被明确识别、定义的错误吧。可能是在我的工作经验中，主要还是停留在倚靠自己保证文档质量的朴素阶段，所以自动化检查工具对我而言，不是特别刚需。

问题4：在技术文档的自动化检查方面，您遇到过/认为还有哪些痛点和难点亟待解决/优化的呢/strong>

如果说有什么问题是比较痛点的，我觉得应该是断链接、样式错误、一致性问题这种，比较“隐形”，不容易被“看”到的错误吧。

TO张童鞋：

这就是今天的分享，也不知道是不是充分，希望能够对你的课题研究有所助益。再次为迟到的回复向你道歉，如果有机会，也欢迎继续交流，谢谢！

相关内容：

实施：GitHub + MarkDown 文档系统的工作环境部署及工作流程说明 | 技术传播

顽固的老头子与无聊的说明书 | 技术传播

转战新媒体 | 技术传播

评测：王者荣耀的用户帮助系统 | 技术传播

让爸爸妈妈也能享受到科技发展带来的便利 | 技术传播

企业级信息管理系统初创方案构思 | 技术传播

睿齐

技术传播从业者

品牌内容策划

自由摄影师

自由撰稿人

汪力迪

公众号：techcomm / htstory

微信号：bgrichi

邮箱：hash_0813@163.com

来源：BGRichi