技术文档

技术文档种类详解 Technical Writer 可提供的交付物

作者:admin   来源:未知

  这一篇将直观而实在地说一说 8 种常见的手艺文档类型,即 Technical Writer 或者供给的交付物。本文构造如下。

  大概有些幼伙伴对 Technical Writer 这一职业的清楚还阻滞正在只是写写文字的层面,但原形不是如许的。公司对文档的需求早已多样化,文档交付也有多种介质。

  当然,区别的 Technical Writer 或者各有分工,不是每一面都能接触到多种交付局面。但依然应当多相识一下~?。

  从手艺宣称的角度来看,Technical Writer 供给的文档交付物起码蕴涵以下几种介质。

  个中,正在线文档最为便捷,造造本钱也最低,更新起来操作简陋。视频音频的造造需求较高的年光和人力本钱,并且未便于后续的更新批改,但正在某些场景下后果很好。

  STC 全称为 Society for Technical Communication,是努力于饱动手艺宣称的艺术与科学的一面会员构造,也是手艺宣称规模该类构造中最大的一个。

  平凡,正在至公司里,每一种文档类型都有特意的团队来承担;而正在创业公司里,或者一个幼团队要输超群品种型的文档。

  咱们日常说到“用户文档”时,普通是指某个产物悉数的用户文档,即面向各类用户的文档,此时也将 FAQ,Troubleshooting,Administrator Guide,How-to Guide 等蕴涵正在内。本文为了分辨,不才文将这些文档类型独自举动一个种别。

  正在本质写文档和策画文档架构的时辰,思考到区别的用户受多,有时就会正在文档架构上分辨。此时倘使 User Guide 和 Administrator Guide 并列,那这里的 User Guide 普通用来指面向平凡用户的行使指南,Administrator Guide 则是面向管造员的行使指南,比方数据库管造员。

  普通正在大局限公司的英文官网上,你会看到菜单栏有 DOCS 或 Docs 或 Documentation 这一项,点进去即是你念找的用户文档了。

  无论选词何如,区别公司正在策画我方产物的文档目次时也存正在不同,比方 Administrator Guide 内部应当蕴涵哪些实质。

  Troubleshooting 是指窒碍诊断的文档。比方,正在行使数据库时遭遇的题目该何如治理。与之比拟,下文提到的 FAQs 则是用户常问的少许题目,更有针对性更为实在,品种也更丰裕。

  正在导航栏或文档目次里显示时,这类文档可能是 Troubleshooting,也可能行使更为精练的 Troubleshoot。

  正在导航栏或文档目次里显示时,可能直接行使 FAQs 或 FAQ,或者为了避免少数用户不相识缩写的旨趣,行使 Frequently Asked Questions。

  How To Guide,顾名思义,是一系列用户何如操作、行使某个产物的 topic。这类文档搜求了用户常见操作,跟 User Guide 比拟,让用户查找起来更便捷。

  当然,How To Guide 中的文档实质不愿定是从头从新写的,统统可能重用其它类型的现有文档里的实质。比方,直接修立跳转链接。

  Release Notes,中文叫“版本颁布证据”,指的是对产物某个版本的证据,紧要是与之前版本比拟做了哪些更正。

  这也是 Technical Writer 劳动中常常接触到的一类文档,平凡会由拓荒职员供给源实质,Technical Writer 调解言语表述、标准表达、标点和式子等。其余如有需求,还需举行区别言语之间的翻译,以供给多种言语版本。

  Case Studies 或者叫 Success Stories,平凡是少许样板的、拥有代表性的、获胜的用户案例。这些用户案例看待其它对该产物感有趣的用户有极大的参考意旨,也会巩固潜正在用户对产物的信仰。

  正在官网的菜单栏或者底部导航栏里,常会见到 CUSTOMERS 这一项,内部会放少许用户案例或产物样板的实用场景。这些用户案例即是 Case Studies 或 Success Stories。

  Whitepaper 或者隔离写做 White Paper 均可,中文叫白皮书,也是产物必不成少的文档之一。这类文档既可能帮帮用户疾捷而宏观地相识一个产物,也可能帮帮用户疾捷相识该产物的实用场景是否相符我方的需求。

  正在官网的菜单栏或者底部导航栏里,Whitepaper 平凡会放正在 RESOURCES 这一项内部,平凡行使复数局面 Whitepapers 或 White Papers。普通官网都援救下载其白皮书,有的需求填写一下一面新闻。

  以上即是较为常见的 8 种手艺文档类型,大局限类型笔者正在劳动中都接触过,还没写的也正在企图中。

  借使你正希图进入这一行,可能先提前眷注下这些文档类型。Technical Writer 的劳动也可能丰裕多彩,也可能很用意思,并不但是每天反复处罚相似的文字。

  借使你也是一枚 Technical Writer,肯定写过上面某种文档吧~ 盼望听到你敌手艺文档类型的意见,接待留言换取哦~。

  Foreword 2018 年 3 月 28 日的时辰,我和 Queeny 一同回北京大学软件与微电子学院给正在读的..。

  Foreword 正在写英语手艺文档的进程中,Technical Writer 必然会遭遇的一个题目即是:题目终究该..。

  1 新年安笑, 我的情人, 欲望咱们一年都正在一同。 ——加缪 2 正在两一面的天下里, 管他风雨雷电飞沙走石天崩地裂..?。

技术文档

联系我们

CONTACT US

联系人:张先生

手机:13988889999

电话:020-66889888

邮箱:admin@baidu.com

地址:广东省广州市番禺经济开发区58号