什么是ISO 19678：2018？

ISO 19678：2018是一个标准，可为各种行业提供技术写作的指南和要求。它制定了清晰和简洁的沟通原则，以确保其预定的受众很容易理解技术文档。

ISO 19678：2018：2018

ISO 19678的主要目的：2018是为了为技术，流程或系统创建文档时，为技术作家制定一组准则。这些指南旨在提高技术沟通的清晰度和有效性，使用户能够更轻松地了解复杂的信息。

ISO 19678：2018

ISO 19678：2018概述了几个关键的关键要求技术作家应遵守的要求：

一致性：技术文档在术语，格式和样式方面应保持一致。这样可以确保读者可以在整个文档中以相同的方式找到所需的信息并以相同的方式理解。

清晰：文档应以清晰而直接的方式编写，避免不必要的行话，缩写或模棱两可语言。这有助于消除混乱并确保有效传达该信息。

可访问性：广泛的人，包括具有不同技术知识水平的人，应该可以访问技术文档。作家应考虑其目标受众的需求，并使用适当的语言和示例来阐明复杂的概念。

可用性：文档应具有用户友好且易于浏览。这包括使用标题，子标题，表格和视觉效果在逻辑上组织信息并增强可读性。

ISO 19678：2018：2018

的好处，遵循ISO 19678中规定的指南：2018年，技术作家可以取得多种好处：

改善理解：清晰而简洁的文档可以帮助用户了解如何使用产品，对问题进行故障排除或有效地实施过程。

提高效率： - 编写的技术文档通过向用户提供所需的信息而不会混淆或延迟来节省时间和精力。

增强的安全性：准确而精确的文档可以通过确保用户有最新的方式来降低错误或事故的风险 - 日期和可靠的信息。

一致性：遵循一致的准则提高了技术文档的整体质量和连贯性。

总结，ISO 19678：2018是一个有价值的标准，是为基础奠定了基础进行有效的技术写作。通过遵守其准则，技术作家可以创建清晰，简洁和用户友好的文档，从而促进更好的沟通和理解。最终导致各种行业的效率，安全性和可用性提高。