导航:首页 > 信息技术 > 写技术文档的人叫什么

写技术文档的人叫什么

发布时间:2023-01-06 12:37:38

❶ Technical Writer 不只是写产品说明书的

2018 年 3 月 28 日的时候,我和 Queeny 一起回北京大学软件与微电子学院给在读的学弟学妹们做了一个 分享 。

之后一个学妹找我咨询论文相关的事情,因为她写的论文是关于技术写作的。我根据自己从事技术写作的一些经验和积累的知识,回答了她几个问题。然后她跟我说,“一般的人都以为咱技术写作就是写说明书的,学姐有时间了可以专门写一篇推送”。

当别人让你解释 Technical Writer 是干嘛的时,回答说写说明书的或许可以让对方快速理解。但那只是一个方面而已,并不能涵盖 Technical Writer 的所有工作。

你有没有遇到过不知该如何给别人解释清楚 Technical Writer 到底是做什么的尴尬境地?尤其是当父母或其他长辈们问起的时候……

说的多了吧,他们可能理解不了,也不想理解;说的少了吧,他们可能觉得你的工作就是干这么点儿事儿啊。最后想想,算了,佛系回答吧~

之前跟大家分享过 两分钟趣味解读 Technical Writer 的一个小视频,还附上了一个 Technical Writer 怎么跟别人解释自己的工作的漫画版。

最近还在网上看到一个用 DITA 写技术文档的 Technical Communicator 跟别人解释自己工作的对话,好奇的小伙伴可以去看一下。地址: https://techwhirl.com/integrated-technical-communications-a-map-to-better-understanding/

很多尚未进入或者刚刚进入 Technical Writer 这一行的小伙伴可能对技术写作的种类仍然存在认知偏差,认为技术写作就只是写产品说明书的。同时,对 Technical Writer 这一职业本身的认识也有待刷新。

或许,用另外一个表达可以在某种程度上减轻这种认知偏差,即 Technical Communicator。

业内对这类岗位的叫法不一,Technical Writer 是相对来讲比较普遍的叫法,中文叫法一般为“技术文档工程师”,也有叫 Information Developer 或 Content Strategist 的,这样听起来就高大上多了有木有~

另外,这个岗位在有些公司是设立在研发部门中的。

这里所说的技术写作的种类 (Technical Writing Categories) 即 Technical Writer 可提供的 deliverables 的种类。

在分工很细的大外企里,Technical Writer 或许只负责某个技术写作种类中特定部分的工作,轻易不会改变。相比之下,在其它企业尤其是创业公司里,Technical Writer 这个名称就完全不能涵盖实际承担的工作了,已不能从传统的认知去理解。

有的外企 Technical Writer 或许工作几年也只接触到一种类型而已;而在快速发展的技术型创业公司里,Technical Writer 就会快速接触到多种技术写作的类型,虽然承担的工作内容多了,但有利于个人快速成长。

如果细数起来,Technical Writer 写的文档包括许多种类,这里先跟大家分享一些常见的,你如果进入 Technical Writer 这一行很可能会接触到的文档类型。如下所示:

只看上面这些词,或许有点一知半解。没关系,我会在稍后的文章中对这些文档类型做一个具体而直观的分享。

时代在变化,行业和岗位也在变化,所以我们要经常地刷新一下自己的认知。

很好奇 Technical Writer 小伙伴们有没有这样的经历呀,觉得自己很机智地跟别人解释了自己的工作?

欢迎留言交流哦~

你可能想读

技术文档诞生记 | 完整的技术写作流程是怎样的?
Technical Writer 日常工作中好用的小工具
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感?
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?(一)
有哪些适合技术传播从业者关注的优质博客?(二)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(上篇)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(下篇)
英语技术文档的标题到底该大写还是小写?
如何使用正则表达式批量添加和删除字符?
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
优质译文不应止于正确,还要 Well-Organized
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记

-END-

❷ 成为一名技术文档工程师需要哪些因素

成为一名技术文档工程师需要哪些因素?

文档工程师,是指协同开发人员,收集资料,安排开发计划,编写企业项目开发所需的各类文档,同时保证文档的质量、安全等的技术人员,他们肩负着软件开发过程中信息处理与整合的重要职责。面对"文档",他们需要完成包括安排开发计划、制定各类模板、跟踪编写进度以及编辑管理等在内的一系列工作,实现文档处理的"一条龙"服务。下面是我为大家整理的成为一名技术文档工程师需要哪些因素的内容,欢迎阅读与参考!

如果你还是在校学生,那么,对你而言,好消息是你有足够多的时间来做准备。通过详细研究各大招聘网站上的技术文档工程师岗位要求描述,你可以得知自己需要自学哪些知识,有针对性地补上技能短板。你可以利用假期找相关的实习机会,为毕业时的简历添加有说服力的一笔。大公司,特别是北京和上海的外企(如微软、IBM等),时不时会提供一些技术文档写作的实习岗位给本科生或者研究生。一般来说,小公司更青睐社招人士,他们需要的是有工作经验的技术文档工程师,因此这类企业往往很少提供对应的实习岗位。坏消息是,整个中国每年能够提供的此类实习机会确实是少了点(而且往往集中在几个大城市),毕竟这个领域的从业群体也不大。不过话虽如此,作为学生的你,哪怕是找一份与技术文档写作稍微有关联的实习(如IT网站编辑、科技翻译等),也不失为一个好选择。

如果你已经参加工作了,想要转型,则情况又有所不同。实际上,很多技术文档工程师并不是一从学校出来就干这行的。有些人原本是做软件本地化工作的,有可能是觉得单纯的翻译工作没意思,于是就转为技术文档写作了。也有些人是理科出身,但是做了一阵研发工作后,觉得自己不适合干技术活,但又发自内心地喜欢技术领域,于是便选择了成为一名技术文档工程师,将技术与写作结合起来。诸如前面这类情形,之前做的是相关度比较高的工作,后来转型就相对容易些。如果你之前从事的工作和技术文档写作完全搭不到边,则麻烦些。你得向雇主证明,自己有成为一名技术文档工程师的潜力。如何证明?文笔好、对相关技术领域感兴趣、关注细节、沟通能力强等等,你可以从各个角度来推销自己。举个简单的例子,你说你自己书面表达清晰,富有逻辑,该如何体现?仅仅在简历上写这么一段貌似自我夸奖的话是不够的,你最好得有拿得出手的东西,例如你有自己的博客,你在上面写了很多技术教程,这就是最好的体现。已经参加工作的人,虽然业余时间没有在校学生那么多,不过只要肯下功夫,每天下班后挤出一两个钟来自学,一年半载的时间足够你做好最基本的知识和技能储备了。

其实,本文虽然谈的是如何成为一名技术文档工程师,但在方法论上仍具有普遍适用性。我认为,如今是信息爆炸的时代,有心人完全可以通过互联网获取足够多的信息(如关注专业领域人士的博客或微博),知道自己缺少哪些技能,需要往哪个方向努力。君不见,IT行业的`大牛中,有很多都是非科班出身的。勇于拥抱变化,敢于跨界发展,才能在职场中,乃至人生中立于不败之地。

延伸阅读:

1、工作内容

1、按照公司文档开发规范进行产品的用户文档编写工作并完成日常维护;

2、制定用户文档的开发计划,并控制计划的执行;

3、集中存储所有文档资料,保证文档版本与代码版本的一致性,维护文档资料的索引表,定期备份文档资料;

4、参与文档的标准化、制度化规范化等工作;

5、参与联机文档编译和测试,相关的技术支持工作;

6、编写产品指标说明书、使用手册,制作演示幻灯片,完成公司宣传册设计、公司网站维护等[1]。

2、职业要求

教育培训:一般要求本科及以上学历,通信、计算机、电子、无线电、自动控制等专业。

工作经验:需具有产品开发和文档编写及绘图软件使用的经验,熟悉软件测试流程、步骤及规范,能够独立设计测试方案,编写测试计划和测试报告;能熟练运用各种办公软件,且尽可能学会使用Rose、ReqPro、SoDA等软件工程方面的软件;具备良好的逻辑思维能力,思路清晰,能够清楚、简明地陈述问题;具备较强的文字表达能力,擅长综合和归纳,尤其是要具有较高的专业英语阅读和写作水准;工作细致耐心,拥有较好的沟通技巧、抗压能力及团队合作精神,较强的责任感及进取精神。

优秀的文档工程师实际是一种复合型人才,他们不光擅长文档的编写,同时对于所编写文档的项目或产品涉及的其他领域包括电子、通信、无线电等有广泛的了解;对于软件文档,优秀的文档工程师不仅熟悉编写过程,也了解最后的测试、运行,这样才能总体把握各个环节,真正扮演好"信息处理中心"的角色。

除此之外,文档工程师在国内是近几年才逐步被人们重视起来的,较之国外,人才的数量素质和相关的管理规范都存在较大差距,因此具有海外学习工作或外资企业等工作经验的人才更具有吸引力。

3、薪资行情

随着企业之间竞争的加剧,能够给用户提供一个清晰易懂、功能全面的文档也已成为公司产品的一个优势,同时随着企业规模的不断壮大,要求对于一些重要的文档进行有效的管理和保存,而有的程序开发人员不愿书写文档,这些原因都造成了对文档工程师的大量需求。文档工程师需要具备全面的公司对应的产品知识以及工作技能和一定的计算机基础,的工作偏于繁琐。

一般情况下,文档工程师新手入行时起薪在每月2000~3000之间,普通文档工程师月薪大约4000元左右,具备两年以上工作经验者可增至8000元左右,工作五年以上,这一数字将提升到10000-15000元。具体的薪资还根据文档工程师的技能水平及具体侧重的领域有很大浮动。

4、职业发展路径

在专业方向上,他们往往拥有与C/C++软件工程师、Java软件工程师、.net软件工程师、PHP软件工程师、软件测试工程师等相似的专业背景,或直接由其分化演变而来,因而具备这些职业的技术能力和工作经验,可向高级工程师、总设计师、总工等方向发展。

在管理方向上,该领域中具备较强统筹能力、沟通能力、管理能力的技术人员可考虑向IT项目经理、技术经理、研发经理等方向晋升。


;

❸ 什么叫程序员

程序员(英文Programmer)是从事程序开发、维护的专业人员。一般我们将程序员分为程序设计人员和程序编码员,但两者的界限并不非常清楚,特别是在中国。

作一个真正合格的程序员,应该具有的素质。

1:团队精神和协作能力

团队精神和协作能力是作为一个程序员应具备的最基本的素质。软件工程已经提了将近三十年了,当今的软件开发已经不是编程了,而是工程。独行侠可以写一些程序也能赚钱发财,但是进入研发团队,从事商业化和产品化的开发任务,就必须具备这种素质。可以毫不夸张的说这种素质是一个程序员乃至一个团队的安身立命之本。

2:文档习惯

文档是一个软件系统的生命力。一个公司的产品再好、技术含量再高,如果没有缺乏文档,知识就没有继承,公司还是一个来料加工的软件作坊。作为代码程序员,必须将30%的工作时间写用于技术文档。没有文档的程序员势必会被淘汰。

3:规范化的代码编写习惯

知名软件公司的代码的变量命名、注释格式,甚至嵌套中行缩进的长度和函数间的空行数字都有明确规定,良好的编写习惯,不但有助于代码的移植和纠错,也有助于不同技术人员之间的协作。 一些所谓的高手甚至叫嚣高手写的代码一般人看不懂,我只能说他不是一名合格的程序员。

4:需求理解能力

程序员要能正确理解任务单中描述的需求。在这里要明确一点,程序员不仅仅要注意到软件的功能需求,还应注意软件的性能需求,要能正确评估自己的模块对整个项目中的影响及潜在的威胁,如果有着两到三年项目经验的熟练程序员对这一点没有体会的话,只能说明他或许是认真工作过,但是没有用心工作。

5:模块化思维能力

作为一个优秀的程序员,他的思想不能在局限当前的工作任务里面,要想想看自己写的模块是否可以脱离当前系统存在,通过简单的封装在其他系统中或其他模块中直接使用。这样做可以使代码能重复利用,减少重复的劳动,也能是系统结构越趋合理。模块化思维能力的提高是一个程序员的技术水平提高的一项重要指标。

6:测试习惯

测试是软件工程质量保证的重要环节,但是测试不仅仅是测试工程师的工作,而是每个程序员的一种基本职责。程序员要认识测试不仅是正常的程序调试,而要是要进行有目的有针对性的异常调用测试,这一点要结合需求理解能力。

7:学习和总结的能力

程序员是很容易被淘汰的职业,所以要善于学习总结。许多程序员喜欢盲目追求一些编码的小技巧,这样的技术人员无论学了多少语言,代码写起来多熟练,我们只能说他是一名熟练的代码民工,他永远都不会有质的提高。一个善于学习的程序员会经常总结自己的技术水平,对自己的技术层面要有良好的定位,这样才能有目的地提高自己。这样才能逐步提高,从程序员升级为软件设计师、系统分析员。

❹ 技术文档工程师是干什么的

主要是编写、维护、修订开发文档,技术说明书、产品说明书,技术项目/方案说明书,等等技术文书工作的。

阅读全文

与写技术文档的人叫什么相关的资料

热点内容
延安葡萄酒代理有哪些 浏览:136
大润发生鲜区的定义指哪些产品 浏览:706
excel如何制作多项目数据图 浏览:427
宁德师范学院什么时候出录取信息 浏览:818
如何退出轻快司机程序 浏览:382
产品流光怎么拍 浏览:244
网站上上传的信息如何排序 浏览:312
学生登记表页面设置数据是多少 浏览:928
企业代理开户的银行卡怎么激活 浏览:829
长治有什么古玩市场 浏览:720
如何代理小黄车 浏览:127
冷门产品视频怎么拍摄 浏览:117
技术学院软件哪个好 浏览:246
离婚调解包括什么程序 浏览:344
目标点是输哪个数据 浏览:747
小程序访问权限在哪里 浏览:823
如何微信小游戏迁移到微信小程序 浏览:648
消毒隔离技术包括哪些 浏览:931
交易猫未发货怎么收货 浏览:115
恒昌惠诚信息咨询怎么样 浏览:435