技术写作从业能力要求(初级)¶
技术写作行业
用户分析
(1) 虚拟角色
(2) 用户旅途
内容设计
(1) 最小化文档设计
(2) 信息模块化设计(或:Topic-based Writing)
(3) 单源设计
内容开发(技术部分)
(1) DITA 的信息分类架构(Concept, Task, Reference, Troubleshooting)
(2) 内容的组织(Linking)
(3) 样式定制
(4) 协同开发
内容开发(语言部分)
(1) 写作风格
(2) 受限语言(ASD-STE)
内容测试
(1) 语言质量检测(Language Tool, Vale等)
(2) 文档功能测试(超链接跳转、无乱码、图片正常显示)
(3) 可用性测试
各项能力的具体要求如下:
技术写作行业¶
知晓技术写作能力在行业中的职位;
知晓技术写作工程师所需要具备的能力;
世界范围内的行业知名协会、机构与组织;
用户分析¶
知道用户分析在技术写作过程中所发挥的作用;
掌握常见的用研方法,如“卡片分类”法;
虚拟角色¶
掌握虚拟角色的主要概念和方法;
能将用研的结果以用户画像的方式输出;
用户旅途地图¶
掌握用户旅途的主要概念和方法;
能将用户使用信息的过程以用户旅途地图的方式的方式输出;
内容设计¶
知道设计环节在技术写作过程中发挥的作用,即针对特定对象进行内容的设计,让内容易读易懂易用;
知道常用的设计方法,如”以用户为中心的设计”、”包容性设计“等;
最小化文档设计¶
知道最小化文档设计方法的历史沿革与主要的理论贡献者;
掌握四个基本原则及其原则下的常见设计启发
能将其用于技术文档写作中;
信息模块化设计¶
掌握该方法的基本概念,即将信息主题化 (Topic),然后以Topic为单位,进行内容的写作;
知晓常见的信息模块化流派(Information Mapping, DITA等)
单源设计 (Single Sourcing)¶
知晓其核心概念,即做内容开发的时候,确保所有的信息仅有唯一的来源,确保信息的一致性;
知晓常见的单源开发方法(例如dita中使用引用、交叉引用、变量等形式确保内容的单源)
内容开发(技术部分)¶
DITA 的信息分类架构¶
掌握业界常用的DITA技术,并能写作各类主题;
掌握 Concept, Task, Reference, Troubleshooting 主题的常见标记集
DITA 内容的组织¶
能将各主题进行链接,形成有组织的内容;
掌握简单的内容重用与复用方法
内容发布¶
知晓常见的交付格式,如PDF、WebHelp或Epub等;
能将内容发布为常见交付格式,并在发布前能输入参数调整输出结果;
样式定制¶
能掌握样式表的基本知识,对输出物格式进行微调;
能读懂 CSS 和 XSL-FO并能修改参数;
协同开发¶
能基于CCMS 或 WebDav/Git/SVN等技术进行协同写作;
内容开发(语言部分)¶
知道写作风格的作用,熟悉科技公司技术语言写作的基本要求;
知晓行业常见的受限语言的规则,如ASD-STE等;