ISO 20737:2017是一个国际标准,它提供了编写专业技术文档的指南。它旨在确保不同行业和领域的一致性,清晰度和可理解性。
ISO 20737:2017:2017
清晰有效的沟通在技术写作领域至关重要。书面技术文件不佳会导致误解,错误甚至安全危害。ISO 20737:2017通过建立一套指南,供技术作家遵循。
通过遵守ISO 20737:2017中概述的准则,技术作家可以创建清晰,简洁,简洁,简洁,简洁的文档。并且易于理解。这不仅提高了文档的整体质量,还提高了其可用性,可读性和可访问性。
ISO 20737:2017
ISO 20737:2017的关键原理强调了几个关键原则在编写专业技术文档时应考虑这一点:
一致性:一致性确保整个文档中的术语,定义和格式在整个文档中均匀。这有助于避免混乱并提高清晰度。
清晰度:清晰的写作消除了歧义,使读者可以轻松掌握预期的信息。应避免或明确解释技术术语。
可用性:文档应以允许用户快速有效地找到信息的方式组织和结构。逻辑标题,子标题和项目符号点有助于此。
可访问性:所有用户(包括残疾人)都应访问文档。应考虑字体大小,颜色对比和替代格式。
可信度:技术文件应证明主题中的专业知识和权威。应当适当地引用事实和来源以提高信誉。
实施ISO 20737:2017:2017
以实施ISO 20737:2017,有效地实施ISO,组织应向其技术作家提供培训和资源。作家应熟悉准则并将其纳入其写作过程中。
常规评论和反馈会议可以帮助确定改进领域并确保持续遵守标准。通过制作ISO 20737:2017的技术写作实践的组成部分,组织可以提高其技术文档的质量和有效性。
联系人:李生
手机:13751010017
电话:0755-33168386
邮箱:sales@china-item.com
地址: 广东省深圳市宝安区西乡大道与宝安大道交汇处宝和大厦6F