什么是ISO 21198：2017？

ISO 21198：2017是一个标准，它建立了编写和构建技术文档的准则。它提供了一个框架来创建专业，一致的技术文章，例如手册，用户指南和规格。

ISO 21198：2017

ISO 21198的主要目的：ISO 21198：2017

2017年是为了提高技术文档的有效性和可用性。它阐述了组织信息，清晰，清晰地介绍信息的原则和最佳实践，并使预期受众可以访问它。

ISO 21198：2017：2017

ISO 21198：2017年涵盖了技术写作的各个方面，包括结构，样式，语言和图形。以下是标准中突出显示的一些关键准则：

结构组织：该文档应具有清晰逻辑的结构，其部分和小节易于导航。强烈建议使用目录和索引表和索引，以帮助读者快速找到信息。

清晰度和可读性：鼓励使用普通语言和简洁句子来确保清晰度和可读性。

术语的一致性应在必要时定义或解释技术术语和行话：该标准强调在整个文档中使用一致的术语的重要性。应提供并遵守关键术语的定义。

图形和插图：视觉辅助工具（例如图表，图表和插图）应在适当的时候使用以增强理解。它们应该被清楚地标记并在文本中引用。

以下ISO 21198：2017：2017

遵循ISO 21198：2017中概述的指南的好处，可以为作家和读者带来一些好处技术文档：

提高了可用性：通过遵守标准化的结构和语言，用户可以轻松找到相关信息并更有效地理解它。

增强的清晰度：清晰而简洁的写作减少歧义和提高理解，从而减少了错误或误解的可能性。

提高效率：术语的一致性和风格为作家和读者节省了时间。它确保可以轻松地找到和理解信息而不会混淆。

更高质量的文档：以下ISO 21198：2017的指南使作者能够创建对组织很好的专业有效的技术文章。

总结，ISO 21198：2017为创建专业技术文档提供了宝贵的指导。遵守其准则可以显着提高此类文件的有效性和可用性，从而使作家和读者受益。