《技术写作》课程教学大纲

2021年2月修订

课程说明

本课程面向北京语言大学高级翻译学院翻译专业（本地化方向）三年级本科生，目的在于帮助学生了解如何为互联网产品撰写内容简洁结构清晰的技术文档。本课程没有先修课程，学生应具备基本的英语阅读和写作水平，并通过此课程进一步提升结构化写作能力、逻辑思维能力和团队协作能力。

学时学分

总课时为32课时，总学分为2学分。

考核方式

平时成绩（40%）+期末项目（60%）

参考资料

陶友兰、谢敏、周全、李晓黎、程少武. 英语技术写作精要[M]. 上海：复旦大学出版社, 2020.
Google. Technical Writing Courses.[EB/OL]. [2021-03-03]. https://developers.google.com/tech-writing .
微信公众号：TC互联技术传播与技术写作社区（微信号：tchulian）

课程大纲

第一周：初探技术写作

参考资料：《技术传播手册》

请仔细阅读本手册的前三章，了解技术传播的概念。

技术传播与技术写作：

早期因为主要的媒介是纸张和文字，表现手段和传播形式都比较有限。进入数字时代后，各种新媒体层出不穷，于是更多的技术手段用来帮助用户。例如视频、动画、网站、维基、虚拟现实和增强现实、聊天机器人等各种手段非常丰富。原有技术写作的称呼已经不能描述行业的实践，于是便有了新的称呼技术传播 (Technical Communication)。
高志军：《技术传播教程》

请观看这个视频：Meet Technical Writers at Google （视频来自YouTube）

课堂练习一：你所在的学校即将召开一次线上家长会，所用软件为腾讯会议。但你身在学校，无法帮助父母加入此会议，因此你准备撰写一份文档。

请尝试使用中文撰写这份文档。

课堂练习二：你的美国朋友Nick想了解如何通过去哪儿网订三张从北京飞往三亚的机票（包含一张儿童票），请撰写一份文档帮助他了解整个流程。

请尝试使用英文撰写这份文档。

第二周：技术写作流程、技术文档类型和技术写作工具

2.1 技术写作流程

计划阶段（Planning）：

· 分析用户（Analyze users）
· 开展调研（Conduct research）
· 组织内容（Organize content）
· 确定交付品（Determine deliverables）

写作阶段（Developing）：

· 建立结构化内容（Create structured content）
· 应用风格（Apply style）
· 使用技术图示（Use technical illustrations）

质控阶段（Revising）

· 审核（Review）
· 可用性测试（Usability test）
· Edit（编辑）

交付阶段（Delivering）

· 发布和分发（Publish and destribute）
· 收集用户反馈（Collect user feedback）

参考：
《英语技术写作精要》P13-P18

2.2 技术文档类型

根据目标用户划分技术文档类型：

产品用户（Product users）：
· Online and embedded help
· User manuals
· Installation guides
· Technical training materials
· Data sheets
· How-to videos
· Troubleshooting guides
· Knowledge base articles
· FAQs
· Release notes
· Glossaries
· Blogs

系统管理员（System administrators）：
· Installation guides
· Environment guides
· Data sheets
· How-to videos
· Troubleshooting guides
· Glossaries

开发者（Developers）：
· API documentations
· SDK documentations

消费者（Consumers）：
· Brochures and pamphlets
· White papers
· Blogs

决策者（Decision makers）：
· Project proposals
· Technical reports
· White papers

生产者（Producers）：
· Design or product specification

同事或雇员（Colleagues or employees）：
· Business memos
· Internal processes and standards
· Business letters

参考：技术文档种类详解
2.3 技术写作工具

技术写作（非结构化）：
· Microsoft Word
· Adobe FrameMaker (XML Editor)
· Adobe RoboHelp (XML Editor)
· Madcap Flare (XML Editor)

结构化写作：
· Oxygen XML Author (XML Editor)
· PTC Abortext Editor (XML Editor)
· Adobe FrameMaker (XML Editor)

轻量级标记写作：
· Markdown 编辑器
· Notepad++

组件内容管理系统（Component Content Management Systems, CCMS）：
· Astoria CCMS
· Author-it CCMS
· XDocs DITA CCMS
· IXIASOFT DITA CMS
· PTC Windchill Service Information Manager
· SDL Tridion Docs
· Schema ST4

工具选择方案：

If your delivery is just a page of document, Word can be the best choice. If you require topic reuse and multiple output formats such as PDF and HTML, an XML editor is effective. If you require version control, data-storing, or cross-team collaboration, a CCMS is an excellent and expensive option.

参考：
《英语技术写作精要》P21-P26
《技术传播手册》P36

作业：请在身边寻找一份或多份技术文档，分析其受众、质量和提升手段。
时间：班长或学习委员在下周二晚8:00收集好后通过邮件发送给教师
格式：《技术写作》2021年春季_第二周_姓名_学号.pdf

第三周：技术写作规范和标准

3.1 谁来指定标准？

谁是ISO？

ISO是国际标准化组织（International Organization for Standardization），成立于1947年，总部位于瑞士日内瓦，ISO国际标准以数字表示，例如：“ISO 11180:1993”的“11180”是标准号码，而“1993”是出版年份。

中国于1978年加入ISO，在2008年10月的第31届国际化标准组织大会上，中国正式成为ISO的常任理事国。

谁是IEC？

IEC是国际电工委员会（International Electrotechnical Commission），于1906年正式成立。

成立背景：国际标准化活动是从电工领域开始的。1870年以后，电灯、电热器等家用电器以及各种插头、插座、电阻丝等己得到广泛使用。由于产品质量差、标准不统一，常常发生人身事故。于是，用电安全和电工产品标准化问题被提到日程上来。1887~1900年召开的6次国际电工会议上，与会专家们一致认为，有必要建立一个永久性的国际电工标准化机构。

来源：国际电工委员会简介及组织机构

1957年，我国加入国际电工委员会，拥有了一席之地。
2011年，凭借电力事业举世瞩目的成就，我国终于成为IEC常任理事国。

参考：履新！这个国际组织112年来首次由中国人担任最高领导

谁是ITU？

国际电信联盟是联合国负责信息通信技术（ICT）事务的专门机构。国际电联成立于1865年，旨在促进国际上通信网络的互联互通，1947年成为联合国专门机构。

当我们谈及制定国际标准的组织时，一般指的就是ISO、IEC和ITU。

谁是ANSI？

ANSI是美国国家标准协会（American National Standards Institute），领导美国的标准、合格评定以及其它相关活动，成立于1921年，是私营非盈利机构。ANSI既不是政府机构，也不是标准制定机构。

ANSI是ISO和IEC的常任理事成员之一。

参考：美国国家标准协会/美国标准体系

谁是IEEE？

电气电子工程师学会（IEEE）的英文全称是the Institute of Electrical and Electronics Engineers，其前身是成立于1884年的美国电气工程师协会(AIEE)和成立于1912年的无线电工程师协会(IRE)。前者主要致力于有线通讯、光学以及动力系统的研究，而后者则是国际无线电领域不断扩大的产物。20世纪30年代，“电子学”这个词开始进入工程学词典。虽然许多工程师都同时是AIEE和IRE两个协会的会员，但是新入行的电子工程师们还是更倾向于加入无线电工程师协会。两个协会之间激烈的竞争的结果，造就了双方的合作与合并。1963年，AIEE和IRE宣布合并，电气电子工程师学会（IEEE）正式成立了。

来源：：IEEE介绍

谁是GB？

中华人民共和国国家标准，简称国标（汉语拼音：Guóbiāo，GB），由在国际标准化组织和国际电工委员会代表中华人民共和国的会员机构中国国家标准化管理委员会发布，有时也简称中国国家标准。

强制性国家标准冠以“GB”，推荐性国家标准冠以“GB/T”。与很多ISO国际标准相比，很多国家标准等同采用（IDT，identical to 其他标准）、修改采用（MOD，modified in relation to 其他标准）；2000年以前称作等效采用（EQV, equivalent to 其他标准）或非等效采用（NEQ，not equivalent to 其他标准）。

来源：中华人民共和国国家标准

各个国家的标准制定机构都有哪些？

参考：国际及世界各国的规格/标准组织

3.2 IEC/IEEE 82079-1:2019

IEC/IEEE 82079-1:2019 is jointly developed and published by IEC, IEEE, and ISO and provides general principles and detailed requirements for the design and formulation of all types of instructions for use that will be necessary or helpful for users of products of all kinds, ranging from a tin of paint to large or highly complex products, such as large industrial machinery, turnkey based plants or buildings.

来源：IEC/IEEE 82079-1:2019

原文链接：https://www.doc88.com/p-5367840793617.html

IEC 82079-1 标准包含七个主要章节，第 4 章到第 6 章是其“核心内容”：