什么是ISO 6771：2018？

ISO 6771：2018是一个国际标准，提供了技术写作的指南和建议。它旨在提高技术文档的清晰度和有效性，以确保以一致且易于理解的方式提供信息。

ISO 6771：2018

该标准涵盖了技术的各个方面写作，包括文档结构，术语使用情况，图形表示和参考引用。它强调了创建容易理解的文档的重要性，尤其是对于可能出于各种目的依靠技术文档的非专家读者。

构建技术文档

关键方面之一ISO 6771：2018的解决是技术文档的结构。该标准建议使用标题，子标题和其他格式技术来逻辑地组织信息，以指导读者了解内容。清晰且信息丰富的标题可帮助用户更有效地导航复杂文档，并快速找到特定的信息。

此外，该文档应包括一张目录，其中概述了文档的各个部分和小节。这为读者提供了文档结构的快速，并允许他们直接跳到相关的部分。

术语用法

标准化术语是技术写作的另一个关键方面。ISO 6771：2018建议作家使用明确而简洁的术语，这些术语在目标受众中被普遍理解，并避免行话或不必要的技术语言。应在文档中定义和介绍技术术语，以确保读者可以完全理解内容。

该标准还鼓励在整个文档和相关文档中使用一致的术语。这种一致性有助于防止读者之间的误解和混乱，并建立可靠的词汇量以供将来参考。

图形表示

iso 6771：2018提供了图形表示的指南，例如插图，图，图，图，图，图表，图表，图表图表和表格。这些视觉元素可以通过以更容易访问的格式展示信息来增强对复杂概念的理解。

标准建议图形应清晰，正确标记并附有相关的解释或字幕。它还建议使用一致的所有视觉元素使用一致的样式来保持文档中的均匀性和连贯性。

参考引用

正确地提到外部来源对于确保准确性并在其位置给予信用至关重要。到期的。ISO 6771：2018提供了有关参考技术的准则，包括引文，脚注和书目。

该标准强调了准确援引来源的重要性，无论它们是出版材料，在线资源，在线资源还是个人通信。通过这样做，技术作家可以验证其主张，并允许读者在需要时访问更多信息。

结论

遵守ISO 6771：2018技术写作指南可以显着提高质量的质量和文档的有效性。清晰的结构，标准化的术语，精心设计的图形和适当的参考有助于凝聚力和可理解的技术文档。实施这些建议不仅使读者受益，而且增强了作者和组织的信誉和专业精神。