最近,部门领导安排了一项工作,招聘一名技术文档工程师,HR 小姐姐很是不理解,这是一个什么样子的职位?是需要英语专业的做软件产品工作的?还是需要计算机专业的英语出色的?就这个问题,带大家了解一下这个职位。
本文结构如下:
- 什么是技术文档工程师
- 什么是技术文档
- 技术文档分类
- 技术文档工程师职责
- 技术文档工程师要求
什么是技术文档工程师
通俗来讲,技术文档工程师,即,写使用说明书的工作人员。
什么是技术文档
技术文档 旨在解答用户对产品的各种疑问,帮助用户理解产品的功能,并一步步指导用户开始上手使用产品。
技术文档一般包含产品介绍、快速起步、参考文档等章节。
产品介绍:告诉用户,这款软件能为他带来什么价值。
快速起步:一般针对初级用户,指导用户怎样一步步上手使用产品的基本功能。
参考文档:一般针对高级用户,用户可以根据自己的需要来查询所需功能所在的章节,根据文档来学习如何使用。
技术文档分类
按企业内外部分:
外部文档:提供给企业外部的客户使用,该客户一般为产品的最终用户或基于你的产品进行二次开发的外部公司。
内部文档:提供给企业内部的人员使用。如,不同的项目之间,程序员如果要调用彼此的功能,则需要依赖于技术文档。
按语言分:
中文文档:国内互联网企业,一般都是写中文文档。
非中文文档:外企中,一般情况下需要英语文档,如果有国际化需求,则在英语的基础上将文档翻译成包括中文在内的不同语言。该部分的工作,一般由翻译团队进行负责。
技术文档工程师职责
技术文档工程师的职责一般包括编写技术文档、编写其他文档、管理技术文档。
编写技术文档
编写技术文档主要由以下三个阶段组成。
收集信息:一般需要向特定人员进行收集信息,包括不限于程序员、测试工程师、运维工程师、项目经理、产品经理,等等。
使用产品:从用户的角度来了解产品的使用痛点,更好地编写产品使用手册。
编写文档:按照项目的格式、规范、要求,编写技术文档。
编写其他文档
团队中所有跟文字相关的工作,都会与你相关,包括但不限于产品的需求文档、市场推广文档,团队汇报 PPT 以及产品界面上所有的文字信息等等。
管理技术文档
产品不断更新,文档也需要同步持续更新,因此,管理技术文档主要是对文档进行持续更新、编译、测试与发布。
技术文档工程师要求
一名技术文档工程师,通常会从如下三个方面来考察。
语言能力:非英语专业的,最好有四六级、雅思、托福之类的认证。
技术/逻辑能力:最好了解一到两门简单的编程语言, 不需要太精通,简单了解即可,如,Javascript、Python。
人际沟通能力:因为需涉及到与团队中的其他角色的成员进行沟通,所以一般需要沟通能力强、理解能力佳的。