技术写作课程让您了解科学、技术和商业领域写作的一些最重要的方面,换句话说,就是科学家、护士、医生、计算机专家、政府官员、工程师以及其他类似职业的人在日常工作中进行的写作。
为了学习如何有效地为职场写作,您将学习常见的报告类型、特殊格式的内容如引言和标题、将图形插入报告的简单技巧,以及制作专业外观最终版本的一些技巧。
技术写作课程建立在你在其他写作课程中学到的基础上。但有很多新知识需要学习!如果你目前的工作中涉及一些写作,你会发现可以立刻将你在技术写作课程中学到的知识付诸实践。
关于技术写作
你可能在想这个“技术写作”到底是什么。可能有人还告诉过你,“这是一个让你写火箭科学和脑外科的课程。”其实不是,正如你马上会看到的那样。实际上,技术传播领域在广泛的领域和职业中是至关重要的。它是一个完全专业的领域,有学位课程、认证,甚至还有理论。这个领域发展前景良好,收入潜力大;对于有兴趣在这一领域发展的你来说,一门针对初学者的技术写作课程是一个好的起点。
职场写作。 然而,技术写作课程的重点并不一定是成为一名技术作家,而是介绍在几乎任何技术导向的专业工作中所需的写作技能。无论你从事什么样的专业工作,你可能都会做很多写作——其中很多是技术性的。你对一些基础的技术写作技能了解得越多(这些技能在本指南和技术写作课程中都有涉及),你写作的质量就会越好。这对你所参与的项目、你所在的组织,尤其对你和你的职业发展都是有益的。
“技术的”意思是。 技术沟通(或称为技术写作,如课程常常所称)并不是关于特定技术主题(例如计算机)的写作,而是关于任何技术主题。“技术”一词指的是并不广泛传播的知识,这更多是专家和专业人士的领域。无论你的专业是什么,你都在发展专业知识——你正在成为某个特定技术领域的专家。每当你尝试写作或谈论你的领域时,你都在进行技术沟通。
观众的重要性。 技术传播的定义另一个关键部分是信息的接收者—受众。技术传播是以适应读者(或听众或观众)的需求、理解水平和背景的方式传递技术信息。实际上,这个受众元素如此重要,以至于它成为本课程的基石之一:你将被挑战去撰写关于高度技术主题的内容,但以初学者—非专业人士—能够理解的方式。这种将技术信息“翻译”为非专业人士能够理解的能力,是任何技术传播者的关键技能。在快速技术发展的世界中,人们不断落后,变得技术文盲。技术公司不断在寻找有效的方法来帮助客户或潜在客户理解他们新产品的优点或操作。
所以放松!你不必写关于计算机或火箭科学的内容—写你知道或正在学习的技术专长领域。并计划以一种甚至爷爷也能理解的方式来写它!
非常专业的写作。 继续放松,但你应该知道,专业技术写作人员确实会写关于非常技术性的信息—,这些信息他们无法掌握,除非他们回去攻读博士学位。但等等!技术文档必须在九个月内随产品一起发布!他们是怎么做到的?专业技术写作人员依靠这些策略来确保他们工作的技术准确性:
- 与该产品相关的书籍、文章、报告、网站的研究
- 产品规格:产品应该具备的功能,设计理念
- 与主题专家的访谈:产品专员、开发人员、工程师
- 开发周期中的产品会议
- 产品的现场演示
- 熟悉类似的竞争产品
- 实验产品的工作模型。
- 最重要的是,主题专家对技术写作人员工作的技术准确性和完整性进行审核。
当然,有经验的技术写作者会告诉你,产品开发的速度如此之快,以至于规格有时并不可行,而产品的工作模型也很少可用。这就是为什么主题专家的审核通常是最重要的原因。
关于技术写作课程
在技术写作课程中,主要关注通常是学期末的技术报告。你在课程中的几乎所有活动都是为了培养出具那份报告所需的技能。当然,一些技术写作课程从简历和申请信(通常称为求职信)开始,但接下来你会规划技术报告,然后撰写提案,提出你将要撰写那份报告的建议。之后,你会写短小的技术论文,以便熟悉使用标题、引言、图形和特别通知等内容,更不用说以清晰、简洁、易于理解的方式撰写与特定受众相关的技术主题。
注意: 你应该知道,技术写作课程是写作密集型的。你在技术写作课程中的写作量可能会超过你所上过的任何其他课程。如果你这一学期正在学习物理、微积分和中级会计,并且还预期待宝宝—那么,也许,这并不是技术写作的最佳学期。
关于这本免费的在线技术写作教材
这篇文章是在1980年代中期写的,当时我在德克萨斯州奥斯汀的IBM工作,同时在奥斯汀社区学院担任兼职教师。使用一个名为Interleaf的桌面排版系统,我在大多数学生仍在使用打字机的时期写下了这些内容。这些页面中可能仍然保留着那个时代的痕迹。在1994年,我发现了网络,并开始在午餐时间疯狂地将Interleaf文件转换为HTML,使用我在Emacs中创建的大量宏。在2014年,我开始大规模地 overhaul 这个内容,并尝试将其现代化。其中一些例子来自1980年代早期我在德克萨斯大学的技术写作教学时期。虽然它们有些过时,但仍然是很好的例子。鼓励读者向我发送更新! 大卫
关于作者
阅读有关 作者 这本在线教科书的。
