本文永久链接 – 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. 拥抱主动语态，指令明确无误

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

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

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

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

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技能再上一个新台阶！

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

本文永久链接 – https://tonybai.com/2025/05/13/go-prefer-less-framework

大家好，我是 Tony Bai。

Go 语言自诞生以来，就以其简洁、高效和强大的并发模型赢得了全球开发者的青睐。它的设计者们，包括 Rob Pike、Ken Thompson 这些计算机界的巨匠，在创造 Go 的时候，秉持了一种鲜明的风格：“少即是多” (Less is More)。这不仅体现在其精简的语法和关键字上，更深刻地影响了 Go 社区对于“框架” (Frameworks) 的普遍态度。

虽然 Go 官方从未明确宣称“轻框架或无框架”是其核心哲学，但从其设计选择——如强大的标准库、鼓励组合优于继承——以及社区早期的主流声音来看，Go 显著地倾向于“轻框架”，或者说“反大型、侵入式框架”。

但这种在语言层面推崇的“轻盈”与“自由”，在实际的团队协作和大型项目开发中，究竟是解放生产力的“馈赠”，还是悄然套上了一层限制效率的“无形枷锁”？今天，我们就来探讨一下 Go 社区这种独特的“轻框架”理念。

“轻框架”的初心：拥抱简洁、掌控与标准库的力量

Go 社区对“轻框架”的偏爱，并非空穴来风，而是源于对传统大型框架某些弊端的回避，以及对 Go 自身优势的充分自信：

1. 对“重框架”的反思： Go 的设计者们深谙大型框架（如 Java Spring, Ruby on Rails 等早期版本）在提供便利的同时，也可能带来学习曲线陡峭、过度设计、灵活性受限、性能开销以及难以捉摸的“魔法”等问题。Go 倾向于让开发者更接近底层，更清晰地理解代码的执行路径。
2. 强大的标准库 “自带电池”： 这是 Go “轻框架”理念的底气所在。Go 标准库异常强大且全面，覆盖了网络、HTTP、JSON/XML 处理、加密、并发原语、测试等核心功能。许多在其他语言中需要依赖框架才能便捷实现的功能，Go 标准库直接提供，鼓励开发者首先“向内求”。
3. 组合优于继承，接口驱动设计： Go 语言本身的设计哲学鼓励通过组合小而专注的组件来构建复杂的系统，并通过接口实现解耦和多态。这种范式使得代码更易于理解、测试和维护，自然降低了对庞大、层级复杂的框架的需求。
4. 赋予开发者掌控权： “轻框架”意味着更少的隐藏逻辑和约定。开发者对代码的执行流程有更强的掌控感，这对于构建高性能、高可靠性的系统至关重要。
5. 鼓励针对性解决方案： Go 社区倾向于针对特定问题选择或构建小而美的库，而不是试图用一个“万能框架”解决所有问题。这促进了 Go 生态中大量高质量、专注的第三方库的涌现。

这种“轻框架”理念带来的益处显而易见：

• 学习曲线相对平缓： 开发者可以更快地掌握语言核心和标准库，而不必先学习一个庞大的框架体系。
• 高度灵活性： 开发者可以根据项目具体需求自由选择技术栈、架构模式和第三方库，不受框架的强约束。
• 性能透明且可控： 避免了大型框架可能引入的未知性能开销。
• 社区库的“专而精”： 催生了大量专注于解决特定问题的优秀第三方库，开发者可以像搭积木一样按需选用和组合。

对于许多追求极致性能、需要高度定制化、或者开发者经验丰富的场景，Go 的这种“轻框架”倾向无疑是一种解放。

当“轻盈”遭遇“团队”：浮现的挑战与“结构缺失”感

然而，当我们将视角从个体开发者的“自由创作”转向需要多人协作、长期维护的大型复杂系统时，Go 社区这种“轻框架”的理念，有时却可能带来新的挑战，让团队感受到一种“结构缺失”的困扰，甚至演变成效率瓶颈：

• 缺乏共享约定，导致“决策疲劳”与“风格各异”：

  • 项目结构“百花齐放”： 由于缺乏官方或广泛接受的项目布局“最佳实践”，不同团队甚至同一团队的不同项目都可能采用迥异的目录结构和代码组织方式。这无疑增加了新成员的上手门槛，也使得在项目间复用经验和代码变得困难。
  • 技术选型无尽的“圣战”： 路由用 Gin、Echo 还是 Chi？日志库选 Zap、Logrus 还是标准库 log 加封装？配置管理、数据库迁移、RPC 框架……由于缺乏“一锤定音”的框架推荐，团队常常需要在这些基础组件的选择、集成、封装和推广上耗费大量精力，进行无休止的调研、讨论甚至内部“站队”。
  • “重复发明轮子”的诱惑： 因为没有现成的、整合好的框架提供“全家桶”服务，团队在面对常见需求（如用户认证、权限管理、任务队列）时，更容易倾向于“自己动手，丰衣足食”，这可能导致大量功能相似但实现各异的内部“准轮子”，长期维护成本高昂。

• 基础设施与横切关注点的“重复建设”：

  • “胶水代码”与“基础设施代码”泛滥： 服务间的API调用、错误处理、链路追踪、监控埋点、配置加载、密钥管理等横切关注点，在缺乏统一框架抽象的情况下，往往需要在每个服务或模块中重复实现或集成，导致大量相似的“胶水代码”和“基础设施代码”。
  • DevOps 实践难以标准化： Dockerfile 的编写、CI/CD 流水线的配置、服务部署脚本等，如果每个项目都“各自为政”，难以形成统一、高效的 DevOps 实践，也增加了运维的复杂性。

• 团队协作与项目传承的隐形成本：

  • “雪花服务”林立，知识孤岛化： 每个服务都可能因为开发者的不同偏好和技术选型，演变成一个拥有独特“方言”和“习俗”的“小王国”。这使得代码复用、知识共享、人员在项目间的流动都变得更加困难。
  • 维护与交接的“噩梦”： 当一个高度定制化、缺乏统一规范的“轻框架”项目（甚至可以说是“无刻意设计的框架”）交到新人手中，或者核心开发者离职后，其理解难度和维护成本可能会急剧上升。
  • 团队规模扩大后的困境： 随着团队成员增多、项目复杂度上升，缺乏统一框架带来的沟通成本、集成成本和质量控制难度会指数级增长。

对于追求快速迭代、需要保持高度一致性、或者团队成员经验水平参差不齐的团队来说，Go 这种“过度自由”的“轻框架”理念，有时反而会成为一种负担。开发者可能会怀念在 Rails、Django 或 Spring Boot 这类成熟框架中那种“约定优于配置”、开箱即用的便利感。

实践中的平衡：在“轻盈”与“结构”间寻找智慧

面对 Go 社区“轻框架”的理念，以及它在团队协作中可能带来的挑战，我们并非束手无策。关键在于如何在享受其“轻盈”与“自由”的同时，有意识地为团队引入必要的“结构”与“秩序”：

• 建立团队内部的“强约定”与“最佳实践指南”：
  • 这是最核心的应对策略。即使 Go 官方不提供，团队内部也必须投入精力沉淀和推广一套自己的项目模板、代码规范（如 Uber Go Style Guide）、推荐库列表（形成内部“技术雷达”）、以及针对常见场景的架构模式和解决方案。
  • 通过严格的 Code Review、定期的技术分享、完善的内部文档，确保这些“内部标准”得到遵守和持续迭代。
• 拥抱“轻框架/微框架”和高质量的第三方库，形成“技术栈共识”：
  • Go 社区有大量优秀的、专注于解决特定问题的库（如 Gin/Echo 用于 Web 开发，GORM/sqlx 用于数据库交互，Zap/Logrus 用于日志等）。团队应在充分调研的基础上，选择并标准化一套适合自己的“技术全家桶”，并围绕它们构建开发模式，避免成员随意引入未经评估的库。
• 善用代码生成、脚手架与项目模板：
  • 针对常见的样板代码（如 API 接口定义、CRUD 操作、项目初始化），可以开发或引入代码生成工具（如 go-swagger, protoc-gen-go 等）和标准化的项目脚手架，提高开发效率，保证代码风格和结构的一致性。
• 强化架构设计能力，明确模块化与接口：
  • 在项目初期投入足够的时间进行良好的架构设计，明确服务边界、模块职责、数据模型和接口定义。清晰的架构是应对复杂性的基石，其重要性在“轻框架”环境下尤为突出。
  • 即使没有框架的强制约束，也要通过清晰的模块化和精心设计的接口来降低耦合，提高代码的可测试性和可维护性。
• 投资于平台工程与 DevOps 工具链：
  • 将基础设施的配置、部署、监控、日志收集等工作尽可能平台化、自动化，减少手动操作和人为错误。
  • 构建统一的 CI/CD 流水线，提供标准化的 Docker 镜像基础，推广基础设施即代码 (IaC) 的理念。
• 审慎评估并引入“有观点”的 Go 开发平台或框架 (如果真正适合)：
  • 近年来，Go 社区也开始涌现一些试图提供更完整解决方案、更具“观点”的开发平台或集成度更高的框架。它们可能内置了项目结构、服务发现、API 定义、部署等方面的约定。如果团队的痛点与这些工具试图解决的问题高度匹配，并且其引入成本和学习曲线可接受，可以考虑审慎评估和引入，它们或许能在 Go 的自由与团队所需的结构之间提供一种新的平衡点。

结语：自由的艺术在于自律与智慧的构建

Go 社区的“轻框架”理念，本质上是将设计的权力和责任更多地交还给了开发者和团队。这既是一种极大的自由，让我们能够摆脱不必要的束缚，打造出极致性能和高度定制化的系统；同时，它也是一种严峻的考验，要求我们具备更高的技术素养、更强的架构能力和更严格的团队自律。

• 对于经验丰富、纪律性强、且有能力驾驭这种自由的团队或个人，它可以释放出巨大的创造力和效率。
• 但对于缺乏经验、规范不足、或追求快速标准化的团队，这种“轻盈”也可能导致“结构缺失”的混乱和低效。

最终，Go 的“轻框架”理念是馈赠还是枷锁，并不取决于理念本身，而取决于使用它的人和团队如何理解这种理念，并有意识地、智慧地去构建适合自己的“秩序”与“结构”。在 Go 的世界里，真正的自由，或许并非随心所欲，而是通过团队的共同智慧和高度自律，构建起一套虽“轻”却不失章法的“隐形框架”，从而在享受简洁与高效的同时，也能保障项目的稳健、协作的顺畅与长远的发展。

你和你的团队在 Go 项目中是如何平衡自由与结构的？你们是否也曾感受到“轻框架”或“结构缺失”带来的困扰，又是如何解决的？欢迎在评论区分享你的宝贵经验和思考！

精进有道，更上层楼！

如果你已经掌握了 Go 语言的基础，渴望在语法强化、代码设计以及工程实践等方面获得更深层次的提升，那么我最新上架的Go语言进阶课程正是为你准备的！这门进阶课程，是我多年 Go 实战经验和深度思考的结晶，旨在帮助你突破瓶颈，从“会用 Go”迈向“精通 Go”。

扫描下方二维码，立即解锁你的 Go 语言进阶之路！

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