在过去几年里，我参与了许多关于DevRel是否应该归入市场营销团队的讨论。归根结底，我不认为是否理解开发者真的很重要。营销团队最大的痛点之一是很难与开发者有效沟通，正如大家都知道的，开发者对“被营销”感到非常敏感。这实际上意味着他们对接触到的内容有很高的要求。他们希望你理解他们需要的信息。他们需要精准、深入和实用的内容。

去年，我看到一家大公司的团队负责人发了一条推文，说他们在选一个新包来用在他们正在开发的功能上。他们放弃某些包的主要原因是因为糟糕的文档和资源。开发人员需要能够理解如何使用软件，以便在开发自己的软件时更加高效。随着我更深入地为开发者创作内容，我正在寻找更多方法来简化向开发者呈现内容的有效方式。在这篇文章里，我将分享如何向技术人员呈现技术内容。

也许开发者的最主要技能就是解决问题。这正是他们的日常工作。他们通常不会问“你的产品能做什么？”而是会思考“这个产品如何帮助我应对当前的难题？”当你创建的内容能够满足这种需求时，你就在为自己赢得信誉。

开发人员总是面临着各种各样的挑战。他们的时间很宝贵，我们必须尊重。你需要简洁明了，创建一个可扫描且结构良好的层次结构，并避免不必要的拖延。这包括他们也对技术细节很感兴趣。他们不仅希望了解如何实现某个功能，更要知道其实现的原因。如果存在限制，要坦诚承认，不要试图掩饰。

有许多方法可以构建有效的内容结构，但有时候有一个框架来保持一致性会很不错。这里有一些我从经验中得到的心得：

C - 代码优先示例

清晰的代码能赢得观众的信任。你可以试试这些方法，这样：

• 可以直接复制粘贴的功能性代码示例
• 解释紧跟在代码后面，而不是在代码前面
• 真实世界的场景而非人为编造的例子

Stripe 被认为是文档标准的公司之一。他们的文档从代码示例开始，展示了 API 的工作方式以及对各种输入的响应，同时还包括了常见使用场景的示例，同时还展示了常见用例。

实用提示：在发布前务必在一个独立的环境中测试你的代码示例。没有什么比发布一个不起作用的代码示例更快地损害你的可信度。

L - 多层次的复杂性

优秀的开发者内容通过分层的信息来适应各种知识水平：

• 新用户和学习者的入门指南
• 经验丰富的用户所需深入的技术细节
• 专家级别的高级用法和优化案例

Twilio的文档在这方面做得特别出色，为初学者提供了快速入门，同时提供详细的API参考和应对复杂情况的高级教程。

生态系统意识 E -

优秀的开发者体验内容应该考虑到你的产品所在更广泛的生态环境。

Vercel 的 Next.js 文档在这方面非常出色，提供了关于 Next.js 如何与各种样式方案、部署平台和状态管理工具互动的指南。

小贴士：为生态系统中的热门工具编写集成指南。这些资源解决了实际工作流程中的问题，展示了你对开发者整体工作环境的了解。

易懂的术语

虽然技术深度很重要，但你应该尽量避免使用不必要的技术术语或市场行话。

开发者的优质内容：

• 首次使用时清楚地定义专业术语
• 避免使用未解释的缩写词
• 全文中保持术语一致

在解释复杂的概念时，我发现从一个与大家熟悉的编程概念相关的类比开始很有帮助。从那时起，你可以逐步过渡到更具体的术语。

R - 可复现的工作流

开发人员不仅需要理解单个功能，还需要理解完整的流程。这样的内容将各个部分连接起来，展示组件如何在可重复的流程中协同工作，是非常宝贵的。

GitHub的文档很好地展示了GitHub Actions的这一理念，通过引导开发人员完成整个CI/CD流程，而不仅仅是在单独讲解各个步骤。（CI/CD指持续集成和持续部署）

小贴士：教程设计成一个完整的旅程，具有明确的起始条件和定义的结果，这样开发者就能轻松重现你的示例。

最成功的公司不会将开发者内容视为营销的附带产物，而是将其视为一个独立的产品，针对特定用户需求进行设计，通过有意义的指标衡量，并根据反馈持续改进。

开发人员是要求最高的内容消费者之一，一旦他们的需求得到满足，他们也是最忠实的用户。优秀的开发人员内容不仅支持你的产品，它会成为你最宝贵的资产之一，以强调其重要性。