news 2026/11/3 21:48:57

6、技术写作风格与在线文档写作指南

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
6、技术写作风格与在线文档写作指南

技术写作风格与在线文档写作指南

1. 避免冒犯读者的写作风格

在写作过程中,风格的考量不应仅仅停留在个人偏好层面,还需注意可能冒犯读者的写作风格。以下几种情况需要特别留意:
-避免幽默:在计算机文档写作中,作者很容易想在文本中加入幽默元素,但应抵制这种诱惑。即使是真正幽默的评论,也会分散读者的注意力,再次阅读时还会令人厌烦。而且幽默往往具有文化性,对美国人来说有趣的内容,可能会冒犯其他国家的读者。
-示例:原句 “You can use a mouse (one without fur) in conjunction with the window system of your computer.” 中 “one without fur” 分散了读者注意力,句子本意是告知鼠标与窗口系统的关系。
-改写:“The mouse is a versatile tool that you use with the window system of your computer.”
-避免性别歧视语言:在语言使用上,性别歧视问题不容忽视。过去 “men” 常指 “男人和女人”,“he”、“him” 和 “his” 被视为中性词汇,但如今这种用法已不太被接受,因为这些代词过度预设了个体的性别。
-实现通用性别表达的可接受方法:
-使用复数先行词和复数代词:如 “Tell each user to shut down his m

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/11/2 5:51:34

13、技术文档编写全解析

技术文档编写全解析 在技术领域,文档的编写至关重要,它能帮助用户更好地理解和使用产品。下面将详细介绍技术文档的各个部分、不同类型的技术文档以及编辑在文档编写中的作用。 1. 典型手册各部分的编辑格式 典型手册的各部分通常按照特定顺序排列,以下是各部分的详细介绍…

作者头像 李华
网站建设 2026/11/3 6:50:18

面试常考:如何原地重排数组?这个思路绝了

解题思路 这道题我们用两个指针分别追踪奇数位和偶数位,每次检查最后一个元素是奇数还是偶数,然后把它交换到对应的位置上。 比如最后一个元素是奇数,就把它换到下一个需要填充的奇数位(1, 3, 5…),换过来的元素又成为新的"最后一个元素",继续这个过程。 这样做的优势…

作者头像 李华
网站建设 2026/11/3 6:43:52

Wi-Fi CERTIFIED Multimedia™ (WMM®) 技术概述

1.0 概述 本文档定义了 WMM 的规范,WMM 是基于 IEEE 802.11e 标准补充 [2] 的 802.11 QoS 实现方案。最初提出 WMM 是为了防止因多个不兼容的 802.11e 预标准子集出现而导致的碎片化问题;部署 WMM 将为 802.11 语音、流媒体等服务提供可用的 QoS 功能。 1.1 参考文献 [1] …

作者头像 李华
网站建设 2026/11/3 15:32:13

Astrofy:快速构建现代化个人作品集的免费开源模板

Astrofy:快速构建现代化个人作品集的免费开源模板 【免费下载链接】astrofy Astrofy is a free and open-source template for your Personal Portfolio Website built with Astro and TailwindCSS. Create in minutes a website with Blog, CV, Project Section, S…

作者头像 李华
网站建设 2026/11/2 22:20:05

Opus 音频编解码器深度技术报告:架构原理、传输机制与演进分析

Opus 音频编解码器深度技术报告:架构原理、传输机制与演进分析 1. 引言:音频编码的统一范式 在数字音频处理的历史长河中,音频编码技术长期以来被划分为两个截然不同的阵营:语音编码与通用音频编码。这种二元分化源于应用场景的…

作者头像 李华