Technical Writing One—Introduction | 技术写作1：简介

最新推荐文章于 2024-06-13 23:06:25 发布

EstelleChiang

最新推荐文章于 2024-06-13 23:06:25 发布

阅读量360

点赞数 1

分类专栏：技术写作文章标签：人工智能

原文链接：https://developers.google.com/tech-writing/one#target_audience

版权

技术写作专栏收录该内容

4 篇文章 1 订阅

订阅专栏

仅供学习交流，如有侵权请私信，立即删除。

Target audience

Learning Objectives

Pre-class and in-class components

Hardware and network requirements

Optional units

Technical Writing One teaches you how to write clearer technical documentation.

技术写作1可以教你写出清晰明了的技术文档。

Target audience目标受众

You need at least a little writing proficiency in English, but you don't need to be a strong writer to take this course.

您至少应该有过英语写作经验，但也无需具备很强的英文写作能力。

If you've never taken any technical writing training, this course is perfect for you. If you've taken technical writing training, this class provides an efficient refresher.

如果您此前从未接受过技术写作培训，那么本课程非常适合你。如果此前已学习过技术写作，本课程也可帮助您高效回顾技术写作的要点。

Learning Objectives学习目标

This course teaches you the fundamentals of technical writing. After completing this class, you will know how to do the following:

本课程会教授技术写作的基础要素。完成本课程后，您将掌握以下技巧：

Use terminology—including abbreviations and acronyms—consistently.
- 使用一致的术语（包括缩写词与首字母缩略词）。
Recognize and disambiguate pesky pronouns.
- 明确代词所指，避免使用代词带来的歧义。
Distinguish active voice from passive voice.
- 区分主动语态和被动语态。
Convert passive voice sentences to active voice.
- 将被动语态转化为主动语态。
Identify three ways in which active voice is superior to passive voice.
- 识别主动语态优于被动语态的三种情况。
Develop at least three strategies to make sentences clearer and more engaging.
- 至少学会三种让句子更明晰、更吸引读者的策略。
Develop at least four strategies to shorten sentences.
- 至少学会四种简化语句的策略。
Understand the difference between bulleted lists and numbered lists.
- 理解项目符号列表（无序列表）和编号列表（有序列表）的区别。
Create helpful lists.
- 创建实用的列表。
Create effective lead sentences for paragraphs.
- 为每段内容创作有效的引导句。
Focus each paragraph on a single topic.
- 每段内容仅围绕一个主题/重点。
State key points at the start of each document.
- 在文档开头列出重点。
Identify your target audience.
- 确定目标受众。
Determine what your target audience already knows and what your target audience needs to learn.
- 了解目标读者的已知内容和待学内容。
Understand the curse of knowledge.
- 了解“知识的诅咒”。
Identify and revise idioms.
- 识别并修改习语。
State your document's scope (goals) and audience.
- 阐明文档的内容范围（写作目标）及目标读者。
Break long topics into appropriate sections.
- 将较长的内容拆分成若干小节。
Use commas, parentheses, colons, em-dashes, and semicolons properly.
- 正确使用逗号、括号、冒号、破折号和分号。
Develop beginner competency in Markdown.
- 掌握Markdown的基础知识。

It takes years of focused practice to become a great engineer or a great technical writer. This course will improve your technical writing but will not instantly transform you into a great technical writer.

成为优秀的工程师或技术写作者需要长年累月的实践。学习本课程可以提升技术写作技巧，但无法一夜之间变成技术写作大师。

Pre-class and in-class components课前及课堂内容

The course consists of the following two components:

本课程包括以下两部分内容

pre-class课前内容
in-class课堂内容

You are currently viewing the start of the pre-class component.

你正在浏览的是课前内容。（待修改）

The in-class component enhances the lessons taught in the pre-class components. That said, the pre-class lessons on their own still provide a valuable educational experience.

课堂内容可以巩固课前内容的知识点。也就是说，课前内容具有宝贵的指导意义。

Hardware and network requirements硬件和网络要求

Although this course is optimized for a laptop or desktop, you may take the course on a tablet or phone. If you are taking the in-class component, please note that you'll type a lot.

推荐笔记本电脑或台式电脑，因为本课程已针对二者进行了优化，您也可通过平板电脑或手机来学习本课程。提醒，课堂内容包括练习，需要大量打字。

You need an internet connection to take the course. You cannot download the course. The course is not available on tangible media.

本课程无法保存到本地，需要在线学习。本课程不提供有形媒体。

The course contains a few short videos, all of which are optional viewing. If you want to skip the videos, then you can take the course on a low-bandwidth internet connection.

本课程包括若干段视频，可自行决定是否观看。如果选择跳过视频，可以使用较差的网络连接。