记广东技术传播社区9月线下活动

TIME:2021-09-03 | WRITER:admin

9月15日，广东技术传播社区第二次活动在华侨城另空间顺利举办。

当天天气炎热至酷热，气象台预测超强台风“山竹”将正面影响深圳。前一天得知“山竹”来势汹汹，考虑是否调整活动的时间。早上7点多艳阳高照，果断决定通知报名的小伙伴活动如期进行。

参与这次活动的有新朋友和老朋友。吉祥腾达科技的 Celin ，第二次参加社区活动，大学毕业就进入技术传播行业，从她的身上能感觉很强烈的学习和探索热情，是社区的活跃成员。敏言翻译的 Joanna 刚从广州来深圳定居，一直从事翻译的客户开发和管理，希望通过活动了解技术传播行业。高亚科技的 Jane 一早从广州出发，风尘仆仆来到深圳，先和我们打招呼再去找吃饭的地方。大家满满的热情和正能量！

感谢社区组委会小伙伴阿野为社区活动找到了一个安静、宽敞、明亮的聚会地点，同时降低了活动场地费用。

活动的热场环节依旧是自我介绍。无巧不成书—这次活动的同行大多与翻译行业有关系。有的正在从事翻译职业，有的在翻译公司开发客户和项目管理的，有的是从翻译转到技术写作岗位的。

互动环节中，小伙伴们就工作、学习中的关注点（例如：DITA工具的选择，高校语言专业的学生的就业方向，等等）进行了讨论和交流。

进入分享环节，我先为小伙伴们介绍了使用代码开发工具和流程管理文档的模式。软件企业中的文档团队采用敏捷模式开发产品文档，在内容开发工具和流程上存在许多“貌合神离”的地方，影响了文档的交付和质量。

技术文档如何提高“含金量”，如何让文档开发、管理、发布过程更“智能”，提高获取性和可用性？我们可以借用代码的开发工具和流程。

使用轻量级标记语言取代专门化写作工具，降低内容开发的门槛，工程团队与文档团队协同开发内容，分别专注于技术细节与文档架构，从而提高技术文档的“含金量”；文档评审流程借用代码评审机制，跟踪文档中待改进的问题，激发评审兴趣的同时，提升内容质量；代码开发流程的自动化工具应用于质量检查，减少人工和重复工作，让内容贡献者专注于开发文档内容；持续集成和持续交付工具，定期集成最新版本，一键式网站发布，提高文档的获取性和可用性。

国内外的企业使用文档代码化的模式对技术文档，特别是面向开发者的文档、技术支持文档转换，收到了不错的效果，将转换经验在Write the Docs 社区大会和企业博客分享。

前华为信息架构专家李琳 Emma （公众号：技术传播李琳）为大家分享了三个DITA 实施案例。

Emma向大家深入介绍了使用DITA结构化写作的优势。借用人类演进图描述了结构化写作是企业技术文档写作演进历程中的高级阶段，结构化写作有效地解决了工业化写作的痛点。结构化写作对信息分类，与产品功能和规格相关的信息以概念类和参考类主题进行描述，指导用户完成产品操作和排除故障的说明性信息以任务类型进行描述，通过信息分类对内容进行结构化、模块化。

结构化写作中按自上而下（Top-down）的架构设计文档，基于使用场景，设计内容模块与交付方式，完成内容开发后，按交付模式发布。自上而下的信息架构设计保证了实现企业的业务价值，有效传递产品的设计意图，提高文档团队并行开发的能力，适应读者（用户）的需求变化，提高内容的重复使用能力。

产品信息的开发贯穿整个产品生命周期。例如，在产品需求分析和整理阶段输出功能清单，设计阶段输出规格参数，开发阶段输出接口说明，维护阶段输出故障排除指导说明。通过内容管理系统设计和定义信息的流动，将内容板块按需整合为不同类型的手册（例如：硬件手册、软件手册、操作手册和维护手册），以多种格式发布到交付门户网站。产品信息在内容管理生态体系中得到有效的繁衍、管理和使用。

Emma 逐个分析不同的结构化写作案例中的利与弊。案例一，Microsoft Word中的丰富段落样式，自定义文档模板，自带的语言检查工具，满足了文档团队从编写、管理、排版输出的多方面要求，让文档团队有了“正规军”的感觉。使用Word工具维护文档也有一些不尽人意的地方，例如插图和排版。案例二，从Word到DITA，从TW的角度看，虽然工具不同了，区别不大，还是结构化写作，只是内容和样式分离了，也需要花费学习成本。案例三，从DITA到内容管理系统，编写、评审流程更高效了，快速重用内容模块，文档管理省时省力，但系统复杂、使用流程工序多，发布的还是以往的内容。

Emma总结：DITA正在并将会以轻量化、专门化、可视化、云化演进。

最后，我向大家介绍了下半年国内外行业活动，包括9月中在杭州举办的中国技术传播论坛，11月将在荷兰鹿特丹举办的DITA-OT Day, DITA/CMS欧洲大会以及在德国斯图加特举办的tcworld 2018大会。

活动在愉快的气氛中结束。希望大家在此次社区活动中收获知识。