标签 Git 下的文章

代码之外的必修课:顶级技术文档风格指南如何提升你的工程效率

本文永久链接 – https://tonybai.com/2025/07/14/writing-style-guide

大家好,我是Tony Bai。

作为一名开发者、架构师或运维专家,我们大部分时间都在与代码、系统和架构打交道。然而,我们同样在持续不断地进行另一种形式的“编码”——沟通编码。无论是撰写一个清晰的 README.md,提交一份详尽的 Pull Request 描述,编写项目内部的技术文档,还是在社区中回答一个问题,我们都在扮演着“技术作者”的角色。

代码的质量决定了软件能否运行,而沟通的质量则决定了项目能否高效协作、知识能否有效传承、社区能否健康发展。一份糟糕的文档,如同晦涩难懂的“面条代码”,会极大地消耗团队的精力和热情。

最近,Redhat公司发布了《Red Hat Technical Writing Style Guide》7.1版本。这份指南不仅仅是一系列规则的集合,它更像是一部由顶级开源软件公司沉淀下来的、关于如何通过清晰沟通来提升工程效率的哲学。

在这篇文章中,我将提炼其中的一些精髓,探讨那些能直接提升您和团队工程能力的写作原则,供大家参考。

写作的“第一性原理”:清晰、精确、用户至上

技术文档的首要目标是传递信息,任何模糊、冗长或模棱两可的表达都是工程效率的天敌。指南强调了几个核心原则:

1. 拥抱主动语态,指令明确无误

主动语态让指令更直接、更有力。在指导性文档中,这能显著降低读者的认知负荷。

不推荐 (被动语态) 推荐 (主动语态)
Linuxconf can be started by typing … Type … to start Linuxconf.
新的配置可以被应用通过重启服务。 重启服务以应用新的配置。

对开发者的价值:当用户(或未来的你)阅读操作手册时,清晰的指令意味着更低的出错率和更快的解决问题速度。

2. 杜绝冗余,尊重读者的时间

避免使用不必要的填充词,让每一句话都言之有物。

冗余 精炼
Perform the installation of the product. Install the product.
This problem is located on the /dev/sda1 partition. This problem is on the /dev/sda1 partition.

3. 避免歧义:This 指的是什么?

在技术文档中,代词(如 this, that, it)是歧义的重灾区,尤其对于翻译和非母语阅读者。指南建议明确指出代词所指代的的名词。

- A site can use these to self-assign a private routable IP address space.
+ A site can use these unique local addresses to self-assign a private routable IP address space.

- This causes SSH to lose the recorded identities.
+ This action causes SSH to lose the recorded identities.

对开发者的价值:在复杂的配置说明或问题排查指南中,消除代词歧义可以防止因误解而导致的配置错误。

为全球化社区而写:包容性与可翻译性

开源项目和现代技术团队本质上是全球化的。我们的文档需要被不同文化背景的人阅读和翻译。

1. 使用包容性语言

这是现代技术社区的基石。避免使用可能带有偏见或冒犯性的术语,有助于建立一个更健康、更多元化的社区环境。

  • master/slave -> 推荐使用 primary/replica, controller/worker, leader/follower 等。
  • whitelist/blacklist -> 推荐使用 allowlist/denylist 或 blocklist。
  • 性别代词 -> 避免使用 he/she,推荐使用中性的 they(可指代单数)或直接使用第二人称 you。

2. 为翻译而设计

糟糕的措辞会给机器翻译和人工翻译带来灾难。一些简单的规则可以极大地提升文档的可翻译性:

  • 避免使用俚语和行话:eat your own dogfood (使用自己的产品), boil the ocean (范围过大) 等表达在其他文化中可能完全无法理解。
  • 慎用 may 和 should:may 可能表示“可能性”或“许可”,should 可能表示“建议”或“期望”。使用 can (可以), might (可能), must (必须) 会更精确。
  • 避免名词堆叠:Standard system log management configuration 这种连续名词的组合,在翻译时极易出错。可以调整为 Standard configuration of system log management。

工程师的文字“代码规范”:一致性与标准化

如同 eslint 或 gofmt 为代码提供规范一样,风格指南为我们的文字提供了“格式化”标准。这能确保整个项目文档风格统一,易于阅读和维护。

1. 统一命令语法文档

在展示命令行示例时,保持一致的格式至关重要。

# 一个清晰的命令语法示例
$ git clone [username@]hostname:/repository_filename [directory]
- 使用 $ 表示普通用户,# 表示 root 用户。
- 使用 [] 表示可选参数。
- 使用斜体或描述性词语(如 _filename_)表示 需替换的值。
- 在需要省略输出时,使用 ...output omitted... 标记,而不是随意删减。

2. 精确描述 UI 元素

当描述用户界面时,精确和简洁是关键。

  • 直接了当:不说 Click the Save button,而说 Click Save
  • 名称匹配:文档中的 UI 元素名称(如按钮、菜单项)应与界面上显示的完全一致(包括大小写)。
  • 导航路径:使用 -> 或 →清晰地表示导航路径,例如:Go to Monitoring → Metrics。

3. 避免产品名称的所有格

一个看似微小但能提升专业度的细节:

  • 不推荐: Red Hat OpenShift’s Logging operator creates…
  • 推荐: The Red Hat OpenShift Logging operator creates…

总结与展望:将沟通视为工程技艺

《红帽风格指南》带给我们的最大启示是:清晰、精确、专业的书面沟通不是一种“软技能”,而是工程技艺(Craftsmanship)不可或缺的一部分。它与编写高质量代码、设计健壮架构同等重要。

下一次,当你准备提交一个 Pull Request、更新一份 README,或撰写一篇技术博客时,不妨尝试运用其中的一两个原则:

  • 将一个被动语态的句子改为主动语态。
  • 检查是否有模糊的代词 it 或 this 可以被替换。
  • 思考一下你使用的术语是否足够包容和全球通用。

投资于沟通,就是投资于整个团队的效率和项目的未来。正如一份优雅的代码令人赏心悦悦目,一份清晰的文档同样能带来极致的工程之美。


你的Go技能,是否也卡在了“熟练”到“精通”的瓶颈期?

  • 想写出更地道、更健壮的Go代码,却总在细节上踩坑?
  • 渴望提升软件设计能力,驾驭复杂Go项目却缺乏章法?
  • 想打造生产级的Go服务,却在工程化实践中屡屡受挫?

继《Go语言第一课》后,我的《Go语言进阶课》终于在极客时间与大家见面了!

我的全新极客时间专栏 《Tony Bai·Go语言进阶课》就是为这样的你量身打造!30+讲硬核内容,带你夯实语法认知,提升设计思维,锻造工程实践能力,更有实战项目串讲。

目标只有一个:助你完成从“Go熟练工”到“Go专家”的蜕变! 现在就加入,让你的Go技能再上一个新台阶!


商务合作方式:撰稿、出书、培训、在线课程、合伙创业、咨询、广告合作。如有需求,请扫描下方公众号二维码,与我私信联系。

千呼万唤始出来?Go 1.25解决Git仓库子目录作为模块根路径难题

本文永久链接 – https://tonybai.com/2025/06/07/allow-serving-module-under-subdir

大家好,我是Tony Bai。

对于许多 Go 项目维护者而言,如何优雅地组织一个包含多种语言或多个独立 Go 模块的 Git 仓库一直是个不大不小的难题。将 Go 模块置于仓库根目录虽然直接,但有时会导致根目录文件列表臃肿,影响项目整体的清爽度。而将 Go 模块移至子目录,则面临着导入路径、版本标签以及 Go 工具链支持等一系列挑战。近日,一个旨在解决这一痛点的提案 (Issue #34055) 在历经数年讨论后,终于被 Go 团队正式接受,并将在 Go 1.25 版本中落地。这一变化预示着 Go 模块的管理将迎来更高的灵活性。

在这篇文章中,我就来介绍一下这个Go模块管理的变化,各位读者也可以评估一下该功能是否会给你带来更多的便利。

痛点:子目录模块的困境

提案发起者 @nhooyr 在其 websocket 项目 (nhooyr.io/websocket) 中遇到了典型的问题:当 Go 模块文件直接放在 Git 仓库根目录时,根目录显得非常杂乱。他尝试将 Go 模块移至子目录(例如 ./mod),希望 nhooyr.io/websocket 这个导入路径能直接指向该子目录,而不是变成 nhooyr.io/websocket/mod 这样“丑陋”的路径。

现有的 go-import meta 标签虽然允许自定义导入路径到 VCS 仓库的映射,但在处理子目录模块时存在局限:

  • 直接指定仓库: 会导致导入路径需要包含子目录名,这与期望的简洁导入路径相悖。
  • 运行自定义模块服务器: 虽然可以实现精确映射,但这增加了维护成本,并非所有开发者都愿意承担。
  • 版本标签问题: 当模块位于子目录时,如何正确识别和使用 Git 标签(如 v1.0.0)成为一个棘手的问题。开发者期望的是使用仓库级别的全局标签,而不是为子目录模块创建特殊前缀的标签(如 mod/v1.0.0)。
  • godoc.org 等工具的兼容性: 早期 godoc.org 对子目录模块的支持也不完善(注:该提案提出于2019年,那时godoc.org尚未关闭)。

Apache Thrift 项目也遇到了类似问题,其 Go 库位于 github.com/apache/thrift/lib/go/thrift。如果 go.mod 放在子目录下,导入路径会变长,且无法直接使用项目级别的 Git 标签;如果 go.mod 放在顶层,则会受到仓库中其他语言测试代码的影响,使得 go mod tidy 等操作变得复杂(注:Go 1.25的go.mod增加ignore指令,一定称度上可以缓解该影响)。

提案核心:go-import 的扩展与版本标签约定

经过社区的广泛讨论和 Go 团队的审慎考虑,最终被接受的方案聚焦于扩展 go-import meta 标签,并明确了版本标签的约定:

扩展 go-import Meta 标签

在现有的 go-import meta 标签的三个字段(import-prefix vcs vcs-url)基础上,增加第四个可选字段,用于指定模块在仓库中的实际子目录。

例如,对于 nhooyr.io/websocket 这个导入路径,如果其模块代码位于 github.com/nhooyr/websocket 仓库的 mod 子目录下,其 go-import meta 标签可以这样设置:

<meta name="go-import" content="nhooyr.io/websocket git https://github.com/nhooyr/websocket mod">

当 Go 工具(如 go get)解析这个自定义导入路径时,它会识别到第四个字段 mod,并知道真正的模块代码位于该 Git 仓库的 mod 子目录中。旧版本的 Go 工具会因为字段数量不匹配而忽略此标签,这保证了向后兼容性(旧版本 Go 无法处理子目录,忽略标签是合理的行为)。

版本标签约定

对于位于子目录中的模块,其版本标签必须包含该子目录作为前缀。

继续上面的例子,如果 nhooyr.io/websocket 发布 v1.0.0 版本,其在 github.com/nhooyr/websocket 仓库中对应的 Git 标签应该是 mod/v1.0.0。

Go 工具在解析 nhooyr.io/websocket@v1.0.0 时,会结合 go-import 标签中的子目录信息,去查找 mod/v1.0.0 这个 Git 标签。

对于嵌套更深的子目录模块,例如 nhooyr.io/websocket/example 位于仓库的 mod/example 子目录下,其 v1.0.0 版本的标签则应为 mod/example/v1.0.0。

我们这里用一张示意图来直观展示一下这个约定的工作原理:

这一约定确保了版本标签的唯一性和明确性,避免了不同子目录模块可能存在的标签冲突,以及全局标签与特定子目录模块版本之间的模糊性。Go团队也强调了避免使用全局标签作为回退的重要性,因为这可能导致版本含义随时间变化而产生不一致和校验和错误。

为何选择此方案?

  • 最小化改动与兼容性: 扩展 go-import 标签是对现有机制的平滑增强,对旧版本 Go 工具影响可控。
  • 明确性与一致性: 子目录前缀的版本标签确保了版本指向的唯一性,与 Go 模块系统中对子目录模块版本控制的既有逻辑保持一致。
  • 解决了核心痛点: 允许开发者使用简洁的自定义导入路径,同时将 Go 模块代码组织在 Git 仓库的子目录中,保持了仓库根目录的整洁。
  • 避免复杂性: 相较于引入新的 go.mod 指令(如有开发者曾建议的别名机制)或其他更复杂的仓库结构约定,此方案更为直接和易于理解。

值得注意的是,此提案主要针对使用自定义导入路径(通过 go-import meta 标签声明)的场景。对于直接使用如 github.com/user/repo/subdir 这样的导入路径,当前Go 工具链已经能够处理,但版本标签也需要遵循子目录前缀的规则。此提案并不能改变像 github.com 这类不依赖 go-import 元数据的托管平台的行为。

对 Go Monorepo 实践的深远影响

该提案的接受,不仅仅是对自定义导入路径和子目录模块管理的技术细节改进,更深层次上,它将对 Go 社区中 Monorepo(单一代码仓库)策略的采纳和实践产生积极且重要的推动作用。

Monorepo 的吸引力与 Go 的挑战

Monorepo 模式因其在促进代码共享、实现原子化变更、简化跨组件重构以及统一构建和测试流程等方面的优势,在大型项目和追求高效协作的团队中越来越受欢迎。Google 的大规模 Monorepo 实践以及 etcd 等开源项目所采用的“单一仓库,多 Go 模块”模式,都展示了其价值。

然而,在 Go 语言生态中,原生工具链对 Monorepo 内子目录模块缺乏优雅的支持,一直是制约其广泛应用的一个因素。开发者常常需要在“整洁的仓库结构”与“简洁的模块导入路径及清晰的版本管理”之间做出权衡。

该提案如何赋能 Go Monorepo?

Go 1.25 引入的对 go-import 子目录的直接支持,恰好解决了这一核心痛点:

  • 降低多模块 Monorepo 的实现门槛

通过扩展 go-import meta 标签,开发者可以轻松地将位于 Git 仓库任意子目录下的 Go 模块映射到期望的、简洁的自定义导入路径。这意味着,一个 Monorepo 可以更自然地容纳多个逻辑上独立但可能共享代码的 Go 服务或库,而无需担心导入路径变得冗长或依赖复杂的代理服务器。

  • 标准化子目录模块的版本控制

结合提案中明确的“版本标签需包含子目录前缀”(如 sub_module/v1.0.0)的约定,使得在 Monorepo 中对不同模块进行独立的版本发布和精确的依赖管理成为可能。这与 etcd 项目展示的模式高度一致,为其他希望效仿的项目提供了清晰的指导。

  • 提升代码组织灵活性与可维护性

大型项目或包含多种技术栈的仓库,可以将 Go 代码更合理地组织在符合项目整体架构的子目录中,例如 components/auth_service/go/ 或 libs/go/common_utils/,而这些子目录下的模块依然可以拥有如 my-org.com/auth 或 my-org.com/utils 这样干净的导入路径。

  • 促进更广泛的 Monorepo 采纳

随着这一关键技术障碍的扫除,那些因统一工程标准、简化依赖管理(尤其是内部依赖)、提升CI/CD效率或满足特定交付需求(如白盒交付)而考虑 Monorepo 的团队,将更有信心和理由在 Go 项目中实践这一策略。Go 语言正变得越来越适合构建和管理大规模、多组件的复杂系统。

可以预见,Go 1.25 的这一特性将成为 Go 开发者工具箱中的一个重要补充,它不仅解决了单个模块的组织问题,更为 Go 生态系统拥抱和发展 Monorepo 实践提供了坚实的基础。

进展与展望

该提案已被 Go 团队接受,相关的实现工作也已完成。最初计划在 Go 1.24 发布,后因时间原因推迟至 Go 1.25

一旦此特性随着Go 1.25发布,Go 开发者在组织单仓库多模块(monorepo)或包含非 Go 代码的大型项目时,将拥有更大的灵活性:

  • 可以更清晰地分离不同语言或项目的代码,同时为 Go 模块提供简洁、稳定的自定义导入路径。
  • 例如,一个项目可以有 docs/、python_scripts/、go_module/ 等子目录,而 mycompany.com/myproject 可以直接指向 go_module/。

当然,这也要求模块维护者在发布版本时,正确地创建带有子目录前缀的 Git 标签。

小节

34055 提案的接受和即将落地,是 Go 模块系统在灵活性和易用性上的又一次重要进步。它回应了社区长期以来关于改善子目录模块管理体验的呼声,提供了一个相对简单且兼容性良好的解决方案。虽然它不能解决所有场景下的问题(尤其是对于 github.com 等直接路径),但对于使用自定义导入路径(vanity import path)的开发者来说,无疑是一个值得期待的积极变化。我们期待在 Go 1.25 中看到这一特性的正式落地,并观察它将如何被社区广泛应用。


您是否也曾为 Git 仓库子目录中的 Go 模块管理而烦恼?您认为 #34055 提案的解决方案是否满足您的需求?欢迎在评论区分享您的项目组织经验和对这一新特性的看法!

想深入理解 Go 模块的工作原理、版本管理、依赖解析以及更多企业级 Go 项目架构实践吗?不要错过我们的《Go语言进阶课》专栏,系统提升您的 Go 工程能力!


各位读者,我计划在我的微信公众号上,陆续推出一些付费的“微专栏”系列。 这些微专栏通常会围绕一个特定的、值得深入探讨的技术点或主题(无论是 Go 语言的进阶技巧、AI 开发的某个具体环节,还是某个工具的深度剖析等),以 3 篇左右的篇幅进行集中解析和分享。为什么尝试“微专栏”?主要是希望能针对一些值得深挖、但又不足以支撑一个完整大课程的“小而美”的主题,进行更系统、更透彻的分享。

《征服Go并发测试》微专栏就是我的首次尝试!欢迎大家订阅学习。

** 并发测试不再“玄学”!与 Go 1.25 testing/synctest 共舞 **

你是否也曾被 Go 并发测试中的不确定性、缓慢执行和难以调试所困扰?time.Sleep 带来的 flaky tests 是否让你在 CI 上提心吊胆?现在,Go 1.25 带来的官方并发测试利器——testing/synctest 包,将彻底改变这一切!

本系列文章(共三篇)带你从并发测试的痛点出发,深入剖析 testing/synctest 的设计理念、核心 API 与实现原理,并通过丰富的实战案例,手把手教你如何运用它构建可靠、高效的并发测试。


商务合作方式:撰稿、出书、培训、在线课程、合伙创业、咨询、广告合作。如有需求,请扫描下方公众号二维码,与我私信联系。

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言进阶课 Go语言精进之路1 Go语言精进之路2 Go语言第一课 Go语言编程指南
商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats