本文系 NebulaGraph Community Academic 技术文档工程师 Abby 的参会观感，叙述了她在我国技术传达大会共享的收成以及感悟。
听说，技术内容范畴、传达范畴的专家和决策者们会在我国技术传达大会「tcworld China 2022」大会上共享心得。作为一名技术文档工程师，本着了解相关职业的开展趋势和提高自我为 NebulaGraph 社区发明更大价值的心态，参与了此次大会。 第一次参与 tcworld China 技术传达大会，干货挺多，记载一下参会的收成和感触。
tc，技术内容，全称 technical content。既然是技术内容，那么技术内容是怎么进行传达呢？
初看，会觉得技术传达和作为内容生产者的技术文档工程师或材料开发没有半毛钱联络。然而，是自己管中窥豹了：全场听下来，许多课程主题触及“从内容到营销”，当中不乏营销常出现的词汇——“故事传达”、“内容运营”、“视频传达”等等。即便是针对产品编写的”说明书”，也是需求考虑用户和其运用场景，这正是传达的逻辑。除了触及“从内容到营销”主题，大会还共享了文档出现及修改器的演进和开展、文档工程师的价值等主题内容。
下面由我带我们回顾一下这次的技术传达学习之旅。
课程主题
听了技术传达大会的大部分课程，从「技术文档工程师的价值」到「怎么传达运营技术内容中的各个环节」，本次大会都有对应的课程主题。大会课程主题能够形成一条链路：
注：TW，全称 Technical Writer，即技术文档工程师。
干货及考虑
大会中对技术文档工程师的价值、文档内容修改方法、出现方法、运营方法的现状及开展趋势做了相应的共享。在这过程中，我也收成了一些新常识和有了自己的一些考虑。
技术文档工程师的价值
首要，技术文档工程师是什么？引证百科中的一句话———“文档工程师，是指协同开发人员，搜集材料，安排开发方案，编写企业项目开发所需的各类文档，一同保证文档的质量、安全等的技术人员，他们肩负着软件开发过程中信息处理与整合的重要职责。面对“文档”，他们需求完成包括安排开发方案、拟定各类模板、盯梢编写进度以及修改办理等在内的一系列作业，完成文档处理的“一条龙”服务。”
有人或许会说技术文档工程师便是给产品 / 项目编写文档的人员。这也就延伸出来一个现象：文档工程师的价值常常被挑战。有些老板乃至文档工程师自身会想，为什么企业不练习一个开发工程师来直接写技术文档呢？这样他对技术的了解还会更强。为什么还要建立这样的专职的岗位？
首要，这样的技术人员不太好找，具有技术文档编写才能的技术人大多都期望深耕自身的技术范畴，而不愿意去写这些对“硬”技术才能提高不多的内容。毕竟，相较于文档更轻量的注释已经够让技术人头疼了。别的，便是专业的技术文档所出现的内容无论是可读性，还是对产品的了解会比其他人写出来的更好、更靠近用户。现在，全球许多大企业都在许多聘任技术文档工程师，像海康、阿里都有几十人的技术文档团队，人力缺乏的时分还需求外包。企业愿意支付这样的本钱去招聘相关人才，就证明了技术文档工程师有其独特的价值存在。
这也是为什么会专门存在这样的部分。由于，之前未建立技术文档部分时，其他人来写这块内容出现的效果非常差、用户体会不佳。因而，许多企业才会存在技术文档这个部分，来协助企业处理人员分工问题。假设一个企业里的技术人员既要写东西，还要去做技术或是去规划产品，就会出现超级节点。那么，分工的出现就处理这一痛点：专门的人才从事文档编写，专门的人才来搞技术，这样才能把分工内的东西做精做好。
怎么提高文档团队的影响力
作为文档工程师，首要需求肯定和提高自己的认知维度，提高文档团队的影响力，具体怎么做？参阅下列方法：
- 打破角色固化的认知，拒绝做边缘人。文档角色只能输出内容吗？不止是这样，文档能够发现 bug、了解和剖析用户需求、给产品规划提需求及定见。
- 有意识地练习产品思想，保持对产品的好奇心和敏感度。
- 多触摸实在的用户，去现场给用户训练，更好地了解用户实际运用产品中遇到的问题，减轻用户的学习本钱。像是 NebulaGraph 这类开源产品，会常常查看社区用户常说到的问题，并将该问题和处理方案写在文档中。
- 学习用户体会法则、尼尔森的十大可用性准则，运用「用户旅程地图」开掘机会点 。
- 从用户痛点动身提出问题，并给出初步处理方案，和产品交互进行交流并推动提高用户体会，然后提高文档团队的影响力。
招聘和培养英文技术文档
假如技术内容传达还泛指国际上的传达，那么英文技术文档关于产品的国际化具有关键作用。tcworld China 2022 共享中说到，在进行英文技术写作人员招聘过程中，常常遇到三个问题英文才能缺乏、技术才能缺乏、写作才能缺乏。
当急需人才、短期内又招不到人的情况下，企业能够转变思想，对英文技术翻译人员进行训练。在语言和写作方面，英文技术翻译人员上手会相对较快。剩余的便是对其技术方面的专门训练。像是英文技术文档这种人群的招聘前提也是需求 ta 们具有很强的学习意愿和才能。
文档未来
听完全场，我更喜欢 RWS 呼延韶文教师共享的《文档未来》课程，他从内容的创造方法和内容的运用端两个方面共享了文档的开展趋势。
内容创造方法
文档的发明方法，已经从开始的纸质版转为电子版（Word / PDF）的方法交付。文档正从纸质转变为电子再转变成数字化。文档数字化，指文档内容模块化、结构化、文档生产流程的云化、文档和用户的可交互性。《文档未来》说到 Forrester 预测文档下一个十年，新式依据云端、数据驱动、结构化的文档创造方法将成为主流。依据结构化、模块化主题内容，还可做到文档内容的主动组合、更新主动推送等等。文档内容出现的开展的最终阶段是交互性内容，用户能够和内容进行交互（多以 HTML + CSS 完成）。与技术的互动，从文本到交互界面，是由产品规划引发的潜意识过程所引导的。技术传达者越是了解这种心理过程，越能发明出互动强的文档。
不仅仅《文档未来》说到了文档内容的模块化、结构化，其他的课程《让技术文档智能化交付+多场景出现》、《怎么构建常识百科并营销，共建工业生态》也都说到了文档内容的模块化和结构化。结构化的主题内容能够一源多用，并多格局发布。相对传统的修改方法，结构化能起到降本增效的作用。这种结构化、模块化的内容出现是依据 XML 的体系结构，比较炽热且流行的标准是 DITA 标准。现在，NebulaGraph 技术文档团队正在运用开源的文档修改软件 MkDocs Material（参阅延伸阅读），满意现在的内容复用需求。随着文档内容量不断增多，后续能够考虑运用结构化、模块化的修改软件创造文档内容。
内容运用端
文档内容发布后，用户需求在门户网站阅读文档内容。那么，怎么出现内容或者说怎么组合内容以提高用户体会呢？这个部分的内容和后边《开源网站信息架构的攻守之道》说到的信息架构有相似之处。在运用端（文档网站）能够做的用来提高用户体会的工作：
- 语义化的查找才能，查找引擎能够依据用户的运用场景，查找词语的意思检索到方针内容。
- 常识模块化，依据 XML 体系的内容发布。
- 智能内容，智能机器人能够推送用户查找的问题。
- 考虑用户常查找的关键字，考虑 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 视频，以虚拟人物形象在网路影片平台上传影片或进行直播的创造者。
假如不想露真人，但又想有人物动作的时分，能够考虑制造 VTuber 视频进行。
课程笔记
除了一些因时间冲突没参与外，参与的大部分课程名称及剖析概参阅。
延伸阅读：
- 怎么打造多版别文档中心
谢谢你读完本文 (///▽///)
NebulaGraph Desktop，Windows 和 macOS 用户安装图数据库的绿色通道，10s 拉起搞定海量数据的图服务。通道传送门：c.nxw.so/9Rs1u
想看源码的小伙伴能够前往 GitHub 阅读、运用、(^^)-☆ star 它 -> GitHub；和其他的 NebulaGraph 用户一同交流图数据库技术和运用技术，留下「你的手刺」一同游玩呢~
