简明技术英语(STE)已经使用了超过35年,但直到最近十年,全球才有越来越多的公司采用了这一全球标准,以帮助确保内容写得清晰、简洁。在过去的18年里,我们已经实施了STE,并在全球范围内培训了3000多名技术作者,我们将在本次演讲中解释实施STE所涉及的内容、好处,并介绍采用该标准和检查软件的经济实惠方式。
简明技术英语(STE)已经使用了超过35年,但直到最近十年,全球才有越来越多的公司采用了这一全球标准,以帮助确保内容写得清晰、简洁。在过去的18年里,我们已经实施了STE,并在全球范围内培训了3000多名技术作者,我们将在本次演讲中解释实施STE所涉及的内容、好处,并介绍采用该标准和检查软件的经济实惠方式。
公司越来越多地将其产品开发和服务外包,以降低成本,并专注于其核心业务。他们还从OEM公司(原始设备制造商)购买产品,以扩大他们可以为客户提供的产品组合。与OEM公司的合作使他们能够针对特定的市场需求开发定制化产品。所有这些产品都有相关的内容(软件、文档),这些内容最初是由源头(OEM)公司生产的,现在被客户公司用于其市场。例如,由于品牌重塑、定制和质量要求等原因,一方或双方可能需要调整或重做这些内容。实施所需的更改往往伴随着资源、语言、法律、工具、文化和时间上的挑战。由于OEM有几十个甚至几百个商业客户,他们的源内容面临着被全球许多外部公司重复使用的压力。每个人的预算都很紧张。规划内容被其他几家公司重用,会带来很多挑战。重用一个或多个第三方公司的内容也是一个挑战。演讲要点。本演讲将讨论技术作者在处理B2B环境中共享的内容时可能面临的挑战。我们将讨论在内容质量、项目管理、法律问题、全球化、本地化、工具、术语管理以及与分散在全球各地、不同公司和文化的团队合作等主题上采用的最佳实践。这些开发和再利用内容的最佳实践既适用于产品的原始制造商,也适用于打算转售的产品的买方。
基于主题的写作适合我们的技术文档吗?那我该怎么开始呢? 本演讲将帮助你做出决定,并将涉及到转型时的基本阶段和问题。你需要一个新工具吗?如何最好地处理现有内容?它涉及到项目管理和变革管理,但不涉及到具体的课题工作和现有内容。
每一个技术文档工程师都会面临这样的时刻,他们必须为自己为公司/客户创建的技术文档所做的选择进行辩护。这可能是为他们被要求编写的文档的结构辩护。它可能是更基本的–解释为什么作者认为这些文档是需要的,而不是其他文件。你如何赢得与PM的争论?你应该采取什么步骤来证明你的方式是正确的?
本次网络研讨会的内容包括以下几个方面。什么是游戏化,日常工作活动游戏化的基本原则是什么。当我们获取新知识时,以及当我们享受乐趣时,我们的大脑中会发生什么,以及如何激励最终用户和开发/写作团队通过游戏进行学习。如何将游戏化的基本原则应用到技术写作中,以及技术写手和其他技术专业人员的培训中。一个快速且好玩的实际例子。
新冠疫情再次向我们展示了医疗产品对于拯救生命的重要性。由于这些产品经常在紧张的情况下使用,所以它们需要简单直观的使用手册。作为医疗产品用户界面的一部分,使用信息也需要写得用户友好。可用性工程可以成为提高用户满意度和患者安全的关键。
文档是产品开发的一部分,只有将文档写清楚后,整个开发的闭环才算结束。但许多研发不喜欢也不会技术文档写作,这时,一本详实易用的文档风格指南就十分重要了。英语世界里,Google、微软、IBM 等公司都有自己的文档规范。国内公司的技术文档风格规范也不少,但总体不尽如人意,有些太简单,有些不太适用。 本次演讲我将介绍 PingCAP 公司实际使用的中文技术文档风格指南,以及我在编写该指南时的考量及一些研究,比如国内互联网行业中文技术文档风格指南的发展现状、中英文文档风格对比等。 本次演讲的目标: 为从 0 到 1 建立规范文档体系的 TW 们,在文档写作风格、风格指南编写方面提供参考; 为给国际项目做中文文档本地化的人员提供文档风格上的参考。
声网的 RTC SDK 支持安卓、iOS、Windows 等八大主流平台,C++、Java 等多种编程语言。文档团队需要为所有平台及语言提供相应的 API 文档。随着公司代码量的增加,传统的手写模式越来越难以为继,而同步更新、持续交付的挑战日趋严峻。 一年前,我们的团队正式告别手写模式,采用业内流行的 Docs as code 方式,将 API 注释迁移到代码中,并集中选取了一批文档自动生成工具,生成匹配各平台风格的 API 文档。该演讲会重点介绍 Docs as code 的几大优点、如何选择合适的文档生成工具、艰辛的迁移过程、以及对初创企业来说,如何在设计文档中心之初打好基础,免于频繁切换工具之苦。
完成从传统写作到结构化写作和内容管理的转型,包含前期调研、规划、技术选型、开发、测试、部署以及培训 等方面的经验总结。
中国技术传播领域专家和决策者的行业盛事
微信公众号: