技术文档是任何值得尊敬的公司软件产品的主要组件之一。但并非所有组织都花足够的时间来开发有效的文档。通常，在某些情况下，一个软件产品是智能的和巧妙的，但文档是脆弱的和无助的。 由于技术文档服务于许多目的，并可能影响产品的质量，因此技术文档必须准确，因为它可能导致利益攸关方之间的差距。 对于软件开发团队来说，生成可靠的技术文档是最让人头疼的过程之一。 因此，开发团队包括一名技术作者，他在文档测试过程的帮助下确保技术文档是正确的。 什么是文档测试 文件化测试是在产品测试的整个过程中测试文件化项目的过程。它是一种非功能性的软件测试类型，允许您确保文档处于常量状态。此外，这样的测试过程可以保证您的用户获得更好的体验，并减少作为一名作家在常见问题上的紧张感。 如果一个文档不能工作，可能会有一些问题，如: 读者困惑； 人们因为文件太难以捉摸而错过了福利; 有人可能会受伤，可能会有诉讼或处罚，因为关于危险的信息不够清楚或缺乏。 文档测试揭示文档中的问题，并且在向更广泛的受众展示文档之前，让您了解如何解决这些问题。 文档测试核对表 一般来说，创建文档是为了找到任何有问题的情况的解决方案，并且没有恐慌。这是思考任何技术文档的内容和结构时的一个基本原则。以下是测试文档时要注意的一些品质: 易于理解。如果产品是为普通用户设计的，那么它的文档应该用简单易懂的术语描述用户的操作。服务器和管理软件手册通常适用于系统管理员。使用最适合测试对象的术语。如果你使用了一个特定的术语，那么就值得单独描述它。如果对这个术语有双重解释，请澄清使用的是哪一个。 语法。当然，内容必须正确组成。要检查语法和标点符号，你需要阅读文本，理解它的意思，知道每个使用的术语的意思。您可以使用Grammarly、LanguageTool、WebSpellChecker等特殊工具检查拼写。 场景的效率。文档应该具备的基本品质之一。应准确描述场景;它们的执行应该导致实现产品创建的目标。如果有其他方案，也应该提到。 完整性。描述每个函数元素，无论是一个接口元素，如按钮，复选框等，或命令。任何强制和重要的用户操作都不应该被顺便提及。注意描述所有必要的行动。这样的文件不是贷款协议，其中所有附加条件都是小字说明。例如，如果配置文件包含逗号而不是句点，则值得显式注册应用程序将不运行的信息。 正确性。如果用户赶时间，他们需要找到问题的答案，或者按照说明进行操作，而不需要额外的引用或浪费时间。 结构，方便的文档导航。文档应该有一个清晰的结构，用户应该能够在目录上快速找到信息。如果搜索某些信息需要很长时间，用户可以退出搜索。不是每个人都有耐心去实施行动。当用户打开文档时，所有的文件树、书签等都应该可见。别忘了按字母顺序排列索引或者搜索。所有能帮助用户找到问题解决方案的东西。文本还应该有一个清晰的结构——这样，在任何时候，读者都可以记住他们中断的地方，或者理解哪一段正好包含了他们所需要的信息。 行动的顺序。在某些情况下，步骤的顺序很重要。例如，做汤的时候，我们首先倒水，然后加入其他原料，比如土豆。如果你先把土豆放进去，然后再倒水，然后你会得到不能吃的东西，而不是汤 链接精度。任何在线文件都包含链接。检查一下链接，看看有没有坏掉。通过点击帮助，你可以通过链接查看功能来实现。点击帮助引擎检查: 主题内容中的跨主题链接，样式文件中的资源链接，脚本文件中的链接。 相关性。如果您使用多个版本测试一个软件产品的文档，您应该注意描述的相关性。当前版本的功能可能会发生变化，但文档中没有提到这一点。或者在短时间内决定不在最近发布的版本中包含这个特性，但是这个特性已经在文档中描述过了。日期的相关性，联系信息，系统要求，许可协议，截图等等，也值得注意。 文件检验技术 有三种方法来测试文档的可用性: 释义测试; 正负测试; 基于任务的测试。 释义测试 这样的测试是一个很好的方法，看看人们是否理解文档中的信息。在一个意译测试中，每个参与者一次浏览一个文档的片段。读完每个片段后，捐献者用他们自己的话告诉你，片段里说了什么。这个测试有助于了解: 文件的结构对你的读者来说是有意义的; 你的段落足够短，让人们得到所有的部分; 你的投稿人明白你的用词 贡献者使用的术语与文档中的不同。 在开始测试之前，你应该决定片段之间的间隙在哪里。例如，一个片段可能是一句话，一个短的段落，一个列表，或者一个合同条款。每个片段都要有意义，小到你的贡献者可以理解。 正负检验 这项技术的作者是荷兰研究人员门诺 · 德容和彼得 · 扬 · 谢伦斯。关于正负测试，他们是这么说的: “参与者被要求阅读一份文件，在正面和负面阅读体验之间加上正面和负面的因素。在此之后，我们将通过一次个人访谈来探讨这些优缺点的原因。” 这个测试是了解人们对文件反应的好方法。选择文档中的正负号，取决于它的用途和你想学习的内容。 你可以用正负来表示: 收集参与者对于什么是清晰的，什么是不清晰的意见; 了解人们对一份文件的情绪反应; 研究一些其他的信息。例如，找出文件传递品牌价值的程度。 当我们询问一般的积极和消极反应时，我们通常会得到关于更广泛的话题的评论，比如一份文件的语气和对该文件是否有意义的评论。 任务型测试 不是每份文件都是从头读到尾的。有很多文件，比如手册，保险单，说明书，还有很多其他类型的文件，人们没有通读过。他们只是为了解决问题，检查具体的事实，或者按照指示去做。 通过对文档进行基于任务的测试，您可以观察到贡献者试图使用文档来查找和理解信息。这里的读者是一个只读必要内容的用户。因此，找到合适的地方是至关重要的。读者看到信息，然后扫描阅读，只要足够得到答案，检查事实，或按照说明。 记下你在考试中得到的建议和意见。这会帮助你完善你的文件。如果您不确定应该为文档申请哪个测试，文档的目的可以帮助您决定如何测试它。如果你的文档的目的是详细解释某些东西——无论是现在阅读，参考以后，还是在阅读后采取行动，使用意译测试。正负测试符合一个文档，它能给出一个主题的总体理解，或者创造一种情感，例如，建立信任。如果文档提供了答案或者说明-使用基于任务的测试。 结论 提供高质量的文件有其优势: 用户不寻求放弃产品，技术支持上的负荷减少; 开发团队关于产品应该如何运作的问题更少; 这样更容易销售产品。 可用性测试的文档可以帮助你了解你的文档对于使用者的工作效果如何。当我们创建文档时，我们可能会对它们太熟悉了。测试的结果打破了这种熟悉感，帮助我们更好地决定改变什么，保留什么。 祝你的技术写作好运！ 单击帮助小组 跨平台和设备创建、托管和交付文档