如何当个优秀的文档工程师?从 TC China 看技术文档工程师的自我修养

2023-10-26

本文系 NebulaGraph Community Academic 技术文档工程师 Abby 的参会观感,讲述了她在中国技术传播大会分享的收获以及感悟。

据说,技术内容领域、传播领域的专家和决策者们会在中国技术传播大会「tcworld China 2022」大会上分享心得。作为一名技术文档工程师,本着了解相关行业的发展趋势和提升自我为 NebulaGraph 社区创造更大价值的心态,参加了此次大会。
第一次参加 tcworld China 技术传播大会,干货挺多,记录一下参会的收获和感受。

tc,技术内容,全称 technical content。既然是技术内容,那么技术内容是如何进行传播呢?

初看,会觉得技术传播和作为内容生产者的技术文档工程师或资料开发没有半毛钱关系。然而,是本人坐井观天了:全场听下来,许多课程主题涉及“从内容到营销”,当中不乏营销常出现的词汇——“故事传播”、“内容运营”、“视频传播”等等。即便是针对产品编写的"说明书",也是需要考虑用户和其使用场景,这正是传播的逻辑。除了涉及“从内容到营销”主题,大会还分享了文档呈现及编辑器的演进和发展、文档工程师的价值等主题内容。

下面由我带大家回顾一下这次的技术传播学习之旅。

课程主题

听了技术传播大会的大部分课程,从「技术文档工程师的价值」到「如何传播运营技术内容中的各个环节」,本次大会都有对应的课程主题。大会课程主题可以形成一条链路:

注:TW,全称 Technical Writer,即技术文档工程师。

干货及思考

大会中对技术文档工程师的价值文档内容编辑方式呈现方式运营方式的现状发展趋势做了相应的分享。在这过程中,我也收获了一些新知识和有了自己的一些思考。

技术文档工程师的价值

首先,技术文档工程师是什么?引用百科中的一句话———“文档工程师,是指协同开发人员,收集资料,安排开发计划,编写企业项目开发所需的各类文档,同时保证文档的质量、安全等的技术人员,他们肩负着软件开发过程中信息处理与整合的重要职责。面对“文档”,他们需要完成包括安排开发计划、制定各类模板、跟踪编写进度以及编辑管理等在内的一系列工作,实现文档处理的“一条龙”服务。”

有人可能会说技术文档工程师就是给产品 / 项目编写文档的人员。这也就延伸出来一个现象:文档工程师的价值经常被挑战。有些老板甚至文档工程师自身会想,为什么企业不训练一个开发工程师来直接写技术文档呢?这样他对技术的理解还会更强。为什么还要设立这样的专职的岗位?

首先,这样的技术人员不太好找,具有技术文档编写能力的技术人大多都希望深耕自身的技术领域,而不愿意去写这些对“硬”技能能力提升不多的内容。毕竟,相较于文档更轻量的注释已经够让技术人头疼了。另外,就是专业的技术文档所呈现的内容无论是可读性,还是对产品的理解会比其他人写出来的更好、更贴近用户。目前,全球许多大企业都在大量聘用技术文档工程师,像海康、阿里都有几十人的技术文档团队,人力不足的时候还需要外包。企业愿意付出这样的成本去招聘相关人才,就证明了技术文档工程师有其独特的价值存在。

这也是为什么会专门存在这样的部门。因为,之前未设立技术文档部门时,其他人来写这块内容呈现的效果非常差、用户体验不佳。因此,很多企业才会存在技术文档这个部门,来帮助企业解决人员分工问题。假如一个企业里的技术人员既要写东西,还要去做技术或是去设计产品,就会出现超级节点。那么,分工的出现就解决这一痛点:专门的人才从事文档编写,专门的人才来搞技术,这样才能把分工内的东西做精做好。

如何提升文档团队的影响力

作为文档工程师,首先需要肯定和提升自己的认知维度,提升文档团队的影响力,具体怎么做?参考下列方式:

  1. 打破角色固化的认知,拒绝做边缘人。文档角色只能输出内容吗?不止是这样,文档可以发现 bug、了解和分析用户需求、给产品设计提需求及意见。
  2. 有意识地训练产品思维,保持对产品的好奇心和敏感度。
  3. 多接触真实的用户,去现场给用户培训,更好地了解用户实际使用产品中遇到的问题,减轻用户的学习成本。像是 NebulaGraph 这类开源产品,会经常查看社区用户常提到的问题,并将该问题和解决方案写在文档中。
  4. 学习用户体验法则、尼尔森的十大可用性原则,利用「用户旅程地图」发掘机会点 。
  5. 从用户痛点出发提出问题,并给出初步解决方案,和产品交互进行沟通并推动提升用户体验,从而提升文档团队的影响力。

招聘和培养英文技术文档

如果技术内容传播还泛指国际上的传播,那么英文技术文档对于产品的国际化具有关键作用。tcworld China 2022 分享中提到,在进行英文技术写作人员招聘过程中,常常遇到三个问题英文能力不足技术能力不足写作能力不足

当急需人才、短期内又招不到人的情况下,企业可以转变思维,对英文技术翻译人员进行培训。在语言和写作方面,英文技术翻译人员上手会相对较快。剩下的就是对其技术方面的专门培训。像是英文技术文档这种人群的招聘前提也是需要 ta 们具有很强的学习意愿和能力。

文档未来

听完全场,我更喜欢 RWS 呼延韶文老师分享的《文档未来》课程,他从内容的创作方式和内容的应用端两个方面分享了文档的发展趋势。

内容创作方式

文档的创造方式,已经从最初的纸质版转为电子版(Word / PDF)的方式交付。文档正从纸质转变为电子再转变成数字化。文档数字化,指文档内容模块化、结构化、文档生产流程的云化、文档和用户的可交互性。《文档未来》提到 Forrester 预测文档下一个十年,新型基于云端、数据驱动、结构化的文档创作方式将成为主流。基于结构化、模块化主题内容,还可做到文档内容的自动组合、更新自动推送等等。文档内容呈现的发展的最后阶段是交互性内容,用户可以和内容进行交互(多以 HTML + CSS 实现)。与技术的互动,从文本到交互界面,是由产品设计引发的潜意识过程所引导的。技术传播者越是了解这种心理过程,越能创造出互动强的文档。

不仅仅《文档未来》提到了文档内容的模块化、结构化,其他的课程《让技术文档智能化交付+多场景呈现》、《如何构建知识百科并营销,共建产业生态》也都提到了文档内容的模块化和结构化。结构化的主题内容可以一源多用,并多格式发布。相对传统的编辑方式,结构化能起到降本增效的作用。这种结构化、模块化的内容呈现是基于 XML 的体系结构,比较火热且流行的标准是 DITA 标准。目前,NebulaGraph 技术文档团队正在使用开源的文档编辑软件 MkDocs Material(参考延伸阅读),满足目前的内容复用需求。随着文档内容量不断增多,后续可以考虑使用结构化、模块化的编辑软件创作文档内容。

内容应用端

文档内容发布后,用户需要在门户网站浏览文档内容。那么,如何呈现内容或者说如何组合内容以提升用户体验呢?这个部分的内容和后面《开源网站信息架构的攻守之道》提到的信息架构有相似之处。在应用端(文档网站)可以做的用来提升用户体验的事情:

  1. 语义化的搜索能力,搜索引擎可以根据用户的使用场景,搜索词语的意思检索到目标内容。
  2. 知识模块化,基于 XML 体系的内容发布。
  3. 智能内容,智能机器人可以推送用户搜索的问题。
  4. 考虑用户常搜索的关键字,考虑 SEO 创作内容。

信息架构 IA

在参加这次技术传播大会之前,我只是知道 IA(Information Architecture)这个词比较火,但不懂什么是真正的信息架构。信息架构是什么?用途是啥?参加了大会后,大概知道了 IA 的概念,但是还是有点模糊具体是 IA 是做什么?于是在网上找到了一篇浅显易懂的《如何进行信息架构设计?》。下文仅列举相关概念。

什么是信息架构?

信息架构=信息+架构

信息包括各种文本、图片、影音等元素;架构则对应这些元素的选择、分类、导航和检索。

通俗点说,信息架构就是通过合理的组织和表达各种信息元素,让用户获取并理解信息更容易。为信息与用户认知之间搭建⼀座畅通的桥梁

为什么需要信息架构?

简言之,引用《通过智能内容提供出色的客户体验》课程中的提到的一张图片(如下图),我们可以直观的看出,知识点的不同排列组合与连接是提升体验的关键。那么,如何来排列和连接这些知识,就需要用到信息架构中的构建方式、类型及设计逻辑。

信息架构的构建方式

自上而下、自下而上和综合运用

1.自上而下的构建方式

自上而下的构建方式是由战略层驱动的,根据产品目标与用户需求直接进行结构设计,进行新产品规划或者产品重新定义的时候会用到。

自上而下的构建方式,会先从最广泛的,最有可能满足目标的内容及功能开始分类,再依据逻辑细分次级分类。(MVP 的设计思路)所有分类都是空槽,最后将内容和功能按顺序填入。它有一个明显的缺点是:可能导致现有重要内容被忽略

2.自下而上的构建方式

自下而上的构建方式是由范围层驱动的,根据对现有的内容和功能需求的分析进行设计,这是项目实践中大家最常用的一种方式。

在具体项目实践中,产品或设计师根据对现有内容和功能需求的分析,将它们分别归属到较高一级的类别,从而逐渐构建出能反映我们的产品目标和用户需求的结构。(常用卡片分类法辅助)它也有一个缺点:可能导致不能灵活兼容未来内容变动或增加

3.综合运用的构建方式

正因为自上而下和自下而上都有其明显的缺点,所以,理想的信息架构的构建方式都是综合运用的,同时从战略层和范围层进行驱动,以构建一个适应性强的系统。

一个适应性强的信息架构系统,能把新内容作为现有结构的一部分容纳进来(如图左侧),也可以把新内容当成一个完整的部分加入(如图右侧)。

信息架构的基本单位是节点,节点可对应任意信息要素或信息要素的组合,小到一个字段 / 控件,大到一个界面 / 功能都是可以的。不同场景下,节点的颗粒度不相同。

这些节点的排列方式有 4 种常见的类型,也就是我们所说的信息架构类型。

常见的信息架构类型

常见信息架构有 4 种,层级结构、矩阵结构、自然结构和线性结构

1.层级结构

又叫树状结构或中心辐射结构。

2.矩阵结构

矩阵结构允许用户沿着两 / 多个维度在节点之间移动,最终都可以帮助用户找到想要的信息。

3.自然结构

自然结构不遵循任何一致的模式。节点被逐一连接起来,节点与节点之间有联系,但没有分类。

4.线性结构

在线性结构中,用户不能进行跳转,只能一步一步按顺序浏览对应的信息 。

信息架构的逻辑呈现的 5 个过程

内容运营

数字时代,媒介演变正在降低信息传播的成本和难度。很多技术内容正在通过短视频、问答、直播等形式传播,让受众有机会了解到更多有价值信息,学习到更多的新知识。

除了常规的数据分析、SEO 以外,我对内容运营这块印象最深的是有 3 个课程专门分享通过视频进行技术传播。有个课程分析目前国内有两个视频传播火热的视频平台,抖音和 B 站。

B 站中知识类内容的视频较多,抖音视频主要以生活休闲类为主。除了题材之外,B 站的视频基本上为中长视频,抖音视频以短视频为主。所以,技术类内容因为时长、偏知识题材的原因,视频传播更适合放在 B 站上。

B 站中播放量较多的视频特征:内容硬核、专业的授课老师、趣味性高、与热点结合。

对于制作视频本身,了解到一些视频制作的工具:

还有印象较深的是制作 VTuber 视频,以虚拟人物形象在网路影片平台上传影片或进行直播的创作者。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何当个优秀的文档工程师?从 TC China 看技术文档工程师的自我修养 的相关文章

  • 短视频自媒体涨粉的“小心机“,如何快速涨粉

    今天要分享的也是大家最关心 最头疼的问题 如何让自己的自媒体账号涨粉 关于涨粉 以下是你必须要知道的 01坚持发垂直作品 运营抖音账号 保证持续更新是十分必要的 另外内容选题上要保证足够垂直 每期做一个内容 一方面有利于塑造个人 IP 另一
  • 用户积分营销的三种方式

    私域流量时代下 商家们都纷纷搭建私域流量池来实现引流 增长 但是如果商家只是单纯地通过搭建私域流量池来实现用户进行转化 出来的效果是非常缓慢的 同时对于用户留存以及用户粘性的提升帮助不是太大 因此 我们需要设计一种新的玩法去进行私域流量池运
  • 自媒体素材网站有哪些?推荐几个常用的素材网站

    无论是写公众号图文 还是剪辑视频 都需要大量的素材 所以就跟大家介绍一下素材类的网站 1 视频类素材 第一批 就是一些无版权的素材网站 Pexel Video Pexel Video Pexel Video Mazwai等 这些网站里面的视
  • 管理习惯---思维转变

    福州 雨 湿热 简单描述 想起了香港的蜗居 当然 中庸的福州美于香港不止一点 参加了 管理他人者 说道执行 涉及内容 确定方向与明确目标 授权与跟进 发张直属下级 评估和改善绩效 选择团队成员和建设团队 时间分配 上级谈话 课程来说 偏向中
  • BigQuery基础查询语句整理

    BigQuery 是 Google Cloud Platform 上一种可以让用户以 SQL 语句来查询大规模数据的云服务 它可以让用户以低廉的价格 快速地访问大量数据 而不需要拥有自己的基础架构 BigQuery 支持多种数据格式 如 C
  • 一条十几秒的Tik Tok视频月变现9w,2022年还得是短视频来钱快

    大家好 我是项柚 95后社畜一枚 之前辛辛苦苦给老板打一个月苦工 还没我现在做短视频带来的收益高 仅代表个人收益 从一个不怎么冲浪连抖音都懒得刷的门外汉 短短一个多月 一次性还清了自己的银行卡贷款 4个月攒出来某市中心30w房子的首付 原来
  • 自媒体月入过万的运营攻略,轻松上手

    很多自媒体新手羡慕大V月入过万 同是做自媒体运营 为什么自己不能实现营收过万呢 给大家分享一套月入过万的运营攻略 适合新手们去操作 收藏起来直接套用到运营哦 1 账号定位 清晰的定位是影响后期变现的关键因素 选一个后期容易变现的领域能帮自己
  • 服务器IO测试(Iozone使用)

    1 Iozone工具介绍 测试硬盘读写性能 Mb s 包括随机读写和顺序读写速度 Iozone设置块大小16M 文件大小为物理内存2倍 1倍 0 5倍三组数据 2 测试步骤 2 1 下载 wget http www iozone org s
  • 手把手教你用 ChatGPT plugin 打造一个人知识库系统(一)

    为什么需要个人知识库 大概有很多人跟我一样 被现在信息过载弄得非常焦虑 很自然想到通过整理的方式来对抗信息过载 试图使用各种知识管理工具来整理这些信息 但最后折腾完各种工具后 才发现根本用不起来 因为这些工具常常需要我们按照预设的框架去管理
  • Wetab 标签页:内置多种免费实用优雅小组件的浏览器主页和起始页

    Wetab 是什么 Wetab 是一款基于浏览器的新标签页产品 主张辅助用户打造一个兼具效率与美观的主页 nbsp Wetab 的核心特色便是内置了多种实用 优雅的小组件 今天这篇 主要按照分类详细介绍 nbsp Wetab 中的各个小组件
  • Tik Tok月活12亿 Tiktok和抖音有什么不同 ?

    Tik Tok月活12亿 Tiktok和抖音有什么不同 哈喽大家好 我是项柚 目前从事Tiktok从事2年 首先 我先给大家抛一个对比数据图 国内抖音和tiktok的用户区别以及月活量分布 国内抖音月活量是4个亿左右 tiktok国际抖音月
  • 【第21例】IPD 体系进阶:什么是产品包?什么是需求包?

    目录 目录 内容简介 内容详解 CSDN学院 作者简介 目录 第01例 CDCP 概念决策评审点
  • 制造行业主数据同步集成

    主数据是描述企业核心业务实体的数据 是企业核心业务的主要构成 各个订单 合同以及业务的主体 在企业内部被重复 共享应用的数据 主数据跨越企业各个业务部门以及各类业务系统 是应用系统间数据交互的基础 近期一直北方某制造业进行主数据治理工作 谈
  • 企业和软件工程师外包公司合作有哪些好处呢

    互联网技术的快速发展和普及也加速了企业信息化进程步伐 目前很多企业在加快信息化建设过程中遇到软件人才资源配置问题 正面临如下困境 临时及灵活的用人需求 招聘团队对专业软件开发人员招聘困难 内部软件人力不足 没有招聘编制 软件技术人员用工及管
  • 20个免费视频素材平台推荐

    视频剪辑大神的视频素材是从哪里找的 视频素材不知道去哪里找 那可以看看本文 本文总结了素材的方方面面 包括图片 图标以及视频音频的素材网站整理 再也无需为视频素材烦恼 1 新CG儿 一个特别良心的素材网站 模板和视频都非常丰富 重要的是基本
  • 铨顺宏RFID:根据UWB技术性的矿山开采人员精准定位系统

    计划方案环境及总体目标 伴随着智能技术的持续发展趋势 矿山开采生产模式不断创新 翠绿色 绿色生态 智能化慢慢变成煤业的追求完美 煤业智能化系统 智能化针对矿山开采而言十分关键 不但可以产生生产量的提升 还能够协助减少资金投入和产品成本 提高
  • 【2021应用上架】超详细开发者账号申请&应用上架审核经验整理

    一 准备阶段需要注意的 1 上架前开发者账号申请 申请的主体确定 在公司有多个主体的情况下 用哪个公司主体认证开发者 上架APP时需要考虑到应用相关的各种材料申请在哪个公司名下 材料所属公司主体与开发者账号主体不一致的情况需要开发者花费时间
  • 【数据分析】业务指标的几个相关思考

    业务指标的几个相关思考 1 如何理解数据 拿到数据后 第一步 弄清楚数据里每一列的含义 第二步 对数据进行分类 有助于后期的分析 通常将数据分为 用户数据 行为数据 产品数据 三类 用户数据 指的是用户的基本情况 包括姓名 性别 邮箱 年龄
  • 相比引流,期货公司更应该借助私域提升留存和转化

    近期 我们和很多期货公司都有过交流和沟通 相较于如何提升产品留存和转化 大家似乎更关注如何引流 我理解大家对流量获取的焦虑 但回归运营的底层逻辑 产品的留存和转化其实更为重要 现如今很多期货公司已陆续借助企业微信搭建私域流量池 虽然了解了市
  • 企业软件的分类有哪些|app小程序定制开发

    企业软件的分类有哪些 app小程序定制开发 企业软件是指为了满足企业运营和管理需求而开发的软件系统 根据不同的功能和应用领域 企业软件可以分为以下几个分类 1 企业资源计划 Enterprise Resource Planning ERP

随机推荐

  • uniapp picker实现:市区镇村4级懒加载

    使用这种方法的原因 市区镇村4级数据太大 后台接口响应时间太长 方法实现 样式 view
  • 深度学习各方向开源数据集分类汇总

    转载自 深度学习各方向开源数据集分类汇总 持续更新中 哔哩哔哩 目录 1 小目标检测 2 目标检测 3 人体姿态估计 4 图像分割 语义分割 5 工业检测 6 人脸识别 7 自动驾驶 8 目标跟踪 9 动作识别 10 图像分类 11 图像识
  • 基于Matlab的数字图像水印技术

    基于Matlab 的数字图像水印技术 课题介绍 数字水印技术涉及到许多图像处理算法以及数学计算工具等 如果用普通编程工具实现上述算法 需要要花费大量的时间 MathWorks公司推出的一种简单 高效 功能极强的高级语言 MATLAB语言 它
  • 局部最小值问题

    问题 一个数组 相邻不等 返回任意一个局部最小值 重点是 相邻不等 否则无法用此方法 分析 所谓局部最小值 即左右相邻的数都比他大 当此数为第一个时 只需要右边的比他大即可 最右同理 代码 生成随机数组 相邻不等 void Random a
  • B站疯传!堪称最强!java超级面试资料

    我没有知名企业的工作经历 也没有多么耀目的成就 为什么他们会对我有那么深的印象呢 其实 在我看来 面试都是有迹可循的 也就是说 完全可以用很短的时间准备 却给面试官留下很深的印象 一 好的自我介绍决定了面试的80 不管你相不相信 你适不适合
  • DataX理论知识:简介-框架设计-数据抽取策略

    文章目录 一 简介 二 框架设计 三 数据抽取策略 一 简介 DataX 是一个 异构数据源 离线同步工具 可实现 各种 异构数据源 之间 稳定高效的数据同步功能 设计理念 从 蜘蛛网 到 星型链路 DataX充当一个中转站的角色 二 框架
  • 数据分析——数据特征描述、画箱线图、分组直方图

    数据特征描述 import pandas as pd catering sale r H school 数据挖掘 实验 实验二 catering sale xls data pd read excel catering sale index
  • 如何对SQL Server中的tempdb“减肥”

    SQL Server会自动创建一个名为tempdb的数据库作为工作空间使
  • checkstyle:off 使用注释暂时禁用checkstyle检查

    背景 本文介绍在Gradle中 如何跳过checkstyle对指定的文件 或者指定的代码块 的检查 步骤 1 在checkstyle xml的
  • Typescript常见表达式

    Typescript常见表达式 一 析构表达式 destructuring 1 数组析构表达式 用中括号括起来 var array1 1 2 3 4 function doSomething number1 number2 others c
  • Java基础---反射、多线程

    十 反射机制 1 Java反射机制概述 1 1Java Reflection Reflection 反射 是被犯为动态语言的关键 反射机制允许程序在执行期借助于Reflection API取得任何类的内部信息 并能直接操作任意对象的内部属性
  • datetime.time类介绍

    一 time是一个时间类 由时 分 秒 微妙组成 其构造函数如下 class datetime time hour minute second microsecond tzinfo 参数tzinfo 它表示时区信息 各参数的取值范围 hou
  • window安装docker Desktop和wsl2

    目录 一 先到微软商店下载terminal 也就是power shell 后续命令都在这个里面执行 二 安装docker Destop 1 打开控制面板 2 勾选Hyper V服务 3 根据提示重启电脑 等待更新即可 二 启动Docker
  • 字符串去重的5种方式

    public class Demo public static void main String args String str albcad12l gt sfg gt String newStr quChong5 str System o
  • 深度负反馈

    负反馈放大电路的方块图 因为负反馈放大电路有四种组态 而且对于同一种组态 具体电路也各不相同 所以为了研究负反馈放大电路的共同规律 可以利用方块图来描述所有电路 一 负反馈放大电路的方块图表示法 任何负反馈放大电路都可以用下图所示的方块图来
  • windows服务器禁用135,137,138,139,445端口方法

    windows服务器禁用135 137 138 139 445端口方法 1 防火墙新建入站和出站规则 注意 此方法只针对防火墙已开启的情况下才能实现禁用端口 打开控制面板 系统和安全 Windows Defender 防火墙 在左侧选择 高
  • 安装Apache Hive-2.3.3

    1 Hive是什么 1 1 Hive是数据仓库 数据仓库英文名DataWarehouse 可简写为DW或DWH 数据仓库 由数据仓库之父比尔 恩门 Bill Inmon 于1990年提出 主要功能仍是将组织透过资讯系统之联机事务处理 OLT
  • 【H.264/AVC视频编解码技术详解】十七:帧内预测编码的预测实现方法

    H 264 AVC视频编解码技术详解 视频教程已经在 CSDN学院 上线 视频中详述了H 264的背景 标准协议和实现 并通过一个实战工程的形式对H 264的标准进行解析和实现 欢迎观看 纸上得来终觉浅 绝知此事要躬行 只有自己按照标准文档
  • pandas.read_csv参数整理

    pandas read csv参数整理 转载 读取CSV 逗号分割 文件到DataFrame 也支持文件的部分导入和选择迭代 更多帮助参见 http pandas pydata org pandas docs stable io html
  • 如何当个优秀的文档工程师?从 TC China 看技术文档工程师的自我修养

    本文系 NebulaGraph Community Academic 技术文档工程师 Abby 的参会观感 讲述了她在中国技术传播大会分享的收获以及感悟 据说 技术内容领域 传播领域的专家和决策者们会在中国技术传播大会 tcworld Ch