Shiwei Shang

Thinking will not overcome fear but action will.

土木工程术语及释义

土木工程术语及释义 土木工程术语表，内容主要源于本人某水泥厂项目翻译经验。点这里查看带有插图的文档。 术语 译文 释义 (Rain) downpipe 雨落水管   Acceleration 赶工   ...

Posted by Shiwei Shang on September 29, 2025

Grammar Essentials 读书笔记—三种复合词

Grammar Essentials 读书笔记—三种复合词 英语里有三种复合词： 分开写的复合词：couch potato。 写在一起的复合词：watermelon。 用连字符连接的复合词：father-in-law。 先说结论：它们没有什么区别，有些词还随着时间的流逝变成另外两种形式。使用的时候只需和最新的词典保持一致即可。 关于带连字符的复合词，有几个需要注意的点...

Posted by Shiwei Shang on September 2, 2025

Grammar Essentials 读书笔记—写作的正确方式

Grammar Essentials 读书笔记—写作的正确方式 我们日常对话使用的是口语，而写作的时候使用的是书面语。和口语相比，书面语更正式。因此，写作的时候要注意以下几点： 句子结构要完整。说话的时候，对方能通过说话者的语气、神态、动作等判断说话者想表达的意思。因此说话者可以使用不完整的句子。但写作中，作者要把句子写全。 不要突然转变主语。说话的时...

Posted by Shiwei Shang on September 2, 2025

技术文档写作员的核心素质

技术文档写作员的核心素质 我自 2021 年起从事技术文档写作工作。通过这几年的实践与积累，我认为技术文档写作员应具备以下几项核心素质： 语言能力 技术文档写作通常要求从业者具备较强的英语能力： 听说方面：需能与不同国家的英语使用者顺畅交流。实际工作中，同事可能来自全球各地，而部分地区的口音较重，因此听懂教科书录音只是基础要求，远非终极目标。 读写...

Posted by Shiwei Shang on August 6, 2025

主题式写作-如何写参考话题（reference topic）

如何写参考话题 参考话题的作用 参考话题的主要目的是提供查阅型的信息，也就是那些用户在执行任务时可能会临时查找的内容，比如参数列表、命令语法、字段说明、配置选项等。 它不像任务话题那样教你怎么做，也不像概念话题那样解释原理，而是像“速查表”，让用户快速找到具体信息。 参考话题适合包含哪些内容 参数或字段的名称和说明 命令或语法格式 配置选项及其默认值 键盘快捷键、...

Posted by Shiwei Shang on July 2, 2025

主题式写作-如何写任务话题（task topic）

如何写任务话题 任务话题的定位与作用 任务话题是 DITA 中用于描述操作步骤的主题类型，专为指导用户完成具体任务而设计。它强调清晰、简洁、可执行，是技术文档中最贴近用户实际操作需求的内容单元。 撰写任务话题的核心原则 每个主题只描述一个任务 避免在一个主题中混合多个操作流程（如安装与卸载）。 有助于内容的查找、重用与维护。 任务与概念和参考信息分离 任务主题应聚...

Posted by Shiwei Shang on July 2, 2025

主题式写作-如何写概念话题（concept topic）

如何写概念话题 什么是概念话题？ 概念话题的目标是解释“是什么”，也就是为用户提供背景知识、原理说明或某个术语、功能的定义。它不像任务那样教你怎么做某件事，而是帮助你理解为什么要做这件事，或者这件事背后的逻辑是什么。 举例： 在介绍“如何配置数据库”之前，先用一个 Concept 话题解释“什么是数据库连接池”或“数据库的基本结构”。 概念话题话题适合用来做什么？ 解释产品...

Posted by Shiwei Shang on July 2, 2025

主题式写作-介绍

主题式写作 技术文档写作的一个特点就是主题式写作。这篇博文将介绍什么是主题式写作、它有哪些特点、它和常规写作的区别是什么、主题式写作都包含哪些主题以及为什么技术文档要采用主题式写作。 什么是主题式写作（topic-based writing） 主题式写作指的是将信息拆分为独立且聚焦的小单元，每个主题只讲述一个概念（concept）、任务（task）或参考（reference）内容。例如，一个...

Posted by Shiwei Shang on July 2, 2025

谷歌技术文档写作课程笔记 12 如何写错误提示

如何写错误提示 一个好的错误提示包含三部分信息： 指出错误。首先要告诉用户错误是什么，哪里出现了问题。 说明原因。然后告诉用户为什么出错了，是输入错误还是输入的东西不符合要求，正确的输入的格式是什么。 提供办法。最后告诉用户怎么做，可以提供正确的示例。 错误信息的语言同样要求明确，要做到： 简练。 避免双重否定。 分析受众并提供适合他们的信息。用户是技术人员...

Posted by Shiwei Shang on June 27, 2025

谷歌技术文档写作课程笔记 11 无障碍写作

无障碍写作 按照以下建议，让所有人（包括残障人士）都能更加轻松方便地阅读。 给图片提供替代文本（alt text）。替代文本可以方便盲人和弱势人群知道图片包含哪些信息。替代文本还可以优化搜索结果。 使用足够的对比度。合适的对比度可以让视力有问题的人或者在强光下阅读的人看清文字。 使用包容性词汇。不要使用冒犯的词汇。 使用字体、颜色、标志、图片、方位词等增强视觉效果。这些...

Posted by Shiwei Shang on June 27, 2025

FEATURED TAGS
谷歌技术文档写作课程 DQTI 主题式写作 英语语法
ABOUT ME

A technical writer, translator, and teacher.

✉️ shiwei.shang@qq.com