Shiwei Shang

Thinking will not overcome fear but action will.

人工智能和技术文档写作

人工智能和技术文档写作 近年来,人工智能(AI)的出现给我们的生活带来了很大的变化。在技术文档写作领域,它已经可以根据已有的资料或提示生成草稿、总结文档、并对文本进行润色。 有的文档工程师担心 AI 终有一天会替代自己,有的认为 AI 永远无法替代人类。我觉得,文档工程师的职位不会很快被完全替代。人类具有批判性思维和创新性思维,这是目前的 AI 尚且无法完全替代的能力。目前 AI 生成的...

技术文档写作学习资料

技术文档写作学习资料 如果非要推荐学习资料,那一定是lilin90的这个仓库: Awesome Technical Communication 除了这个仓库外,还有很多很多语法书,写作教程值得一读。 学海无涯,在当今互联网时代,我们可以充分利用网上资源扩充自己的知识。我们需要做的就是搜索自己感兴趣的东西,然后不断地学下去。

技术文档工程师的工作内容

技术文档工程师的工作内容 根据我个人经验,技术文档工程师主要有以下几方面工作: 更新文档中的版本信息,版权信息和配图等。 描述产品缺陷并提供解决方法。 描述软件的新功能,以图文形式列出操作步骤和注意事项。 对已有的内容进行表述上或格式上的更新。

技术文档工程师的一天

技术文档工程师的一天 一天的工作从一杯水开始。早晨来了先接一大杯水,然后打开电脑。 早餐到了,吃着早餐,打开邮箱和Teams,看看有没有人找我。有人找我就看看需要我写什么,怎么写。没有人找的话就按照计划,看看今天该做哪些活儿。 打开Jira,看看今儿个该做哪件事了。 打开编辑工具,打开虚拟机,一边研究新功能,一边写草稿。 中午了,和同事出去吃个饭,吃完在楼下走一圈,逛逛地摊市场。 ...

技术文档写作的工作流程

技术文档写作的工作流程 当我们探索新手机,组装新家具,使用新电器时,我们可能会遇到这样或那样的问题。而解决这些问题的时候,我们往往会查阅它们的说明书、安装手册、用户手册之类的文档。这些文档都属于技术文档。那么,技术文档是怎样生成的呢?本文将根据我自己实际工作经验,以软件行业为例,详细介绍技术文档生成的过程。 收集软件需求,确定工作范围 每一版本的软件都有其目的,要么...

土木工程术语及释义

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

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

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

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

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

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

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

主题式写作-如何写参考话题(reference topic)

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