关于 devrel-content
devrel-content 是一项技能,用于规划和制作教程、文档、对比文章及博客等技术内容。它面向创作开发者内容的团队,涵盖选题研究、代码准确性、SEO 和成效衡量。
主要功能
- 01通过搜索和社区研究验证选题
- 02按内容目标选择形式
- 03规划技术文章与教程结构
- 04检查代码示例的正确性
- 05应用面向开发者的 SEO 方法
- 06追踪内容互动与转化
适用场景
- 01根据反复出现的开发者问题规划教程
- 02发布技术指南前检查代码片段
- 03衡量内容的搜索表现和读者互动
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ jonathimer/ devmarketing-skills --skill devrel-content安装后在 Claude Code 中输入/devrel-content确认已加载。
附带文件README.md
详细介绍
DevRel 内容
这项技能可帮助你创作开发者真正愿意阅读的技术内容:博客文章、教程、文档和思想领导力文章,从而建立信任并推动采用。
开始之前
先加载受众背景信息。 阅读 .agents/developer-audience-context.md,了解:
- 你面向的读者(角色、资历、技术栈)
- 他们的痛点(哪些问题能引起共鸣)
- 他们的原话(他们如何描述问题)
- 语气与风格(内容应当多正式、多技术化)
如果背景信息文件不存在,请先运行 developer-audience-context 技能。
DevRel 内容框架
阶段 1:研究与验证
动笔之前,先确认这个主题值得写。
| 研究类型 | 要做什么 |
|---|---|
| 搜索意图 | 在 Google 上搜索主题。哪些内容已经排名靠前?还有哪些内容缺失? |
| 社区信号 | 搜索 Reddit、HN、Stack Overflow。开发者是否在询问相关问题? |
| 竞品空白 | 竞品写过哪些内容?有哪些内容尚未涉及? |
| 内部数据 | 与此主题相关的支持工单、Discord 问题、GitHub issue |
| 关键词研究 | 使用 Ahrefs/SEMrush 查询技术术语的搜索量 |
警示信号——遇到以下情况时不要写:
- 只有你一个人在意这个主题
- 已经有 10 篇一模一样的文章
- 主题范围太广(“JavaScript 入门”)
- 主题范围太窄(没有搜索量,也没有社区关注)
阶段 2:选择内容类型
根据目标选择合适的格式:
| 内容类型 | 最适合的用途 | 结构 |
|---|---|---|
| 教程 | 教授一项具体技能 | 分步讲解,以代码为主 |
| 指南 | 全面介绍某个主题 | 分节组织,包含参考资料 |
| 对比 | 帮助做出决策 | 以表格呈现,列出优缺点 |
| 公告 | 发布功能/产品 | 新闻导语,说明是什么、为什么、如何使用 |
| 思想领导力 | 树立权威 | 观点、预测、见解 |
| 案例研究 | 提供社会认同 | 问题 → 解决方案 → 成果 |
| 故障排除 | 解决具体错误 | 错误 → 原因 → 修复方法 |
阶段 3:拟定大纲结构
使用以下大纲模板:
# [Title that promises specific value]
## Hook (2-3 sentences)
- State the problem or opportunity
- Establish credibility ("We migrated 10,000 repos...")
- Promise what the reader will learn
## Context (optional)
- Brief background if needed
- Link to prerequisites
## The Meat
### Section 1: [First major concept]
- Explanation
- Code example
- Common pitfall
### Section 2: [Second major concept]
- Explanation
- Code example
- Real-world application
### Section 3: [Third major concept]
- Explanation
- Code example
- Advanced tip
## Putting It Together
- Complete example
- Working code
## What's Next
- Links to deeper content
- Call to action (try the product, join Discord, etc.)
编写代码示例
代码就是内容,务必保证正确。
复制粘贴测试
每个代码示例都必须:
| 要求 | 重要原因 |
|---|---|
| 无需修改即可运行 | 开发者会直接复制粘贴。若代码无法运行,你就会失去信任。 |
| 包含导入语句 | 不要假设他们知道要导入哪些库。 |
| 展示输出结果 | 代码运行成功后,他们应该看到什么? |
| 处理错误 | 真实代码会处理错误,要展示出来。 |
| 使用真实值 | 除非必要,否则不要使用 foo、bar、example.com。 |
代码示例结构
First, install the dependencies:
\`\`\`bash
npm install your-library axios
\`\`\`
Now create a file called `fetch-data.js`:
\`\`\`javascript
// fetch-data.js
import { Client } from 'your-library';
import axios from 'axios';
const client = new Client({
apiKey: process.env.YOUR_API_KEY // Use environment variables
});
async function fetchUserData(userId) {
try {
const user = await client.users.get(userId);
console.log(`Fetched user: ${user.name}`);
return user;
} catch (error) {
console.error(`Failed to fetch user: ${error.message}`);
throw error;
}
}
// Example usage
fetchUserData('user_123')
.then(user => console.log(user))
.catch(err => process.exit(1));
\`\`\`
Run it:
\`\`\`bash
YOUR_API_KEY=sk_test_xxx node fetch-data.js
\`\`\`
Expected output:
\`\`\`
Fetched user: Jane Developer
{ id: 'user_123', name: 'Jane Developer', email: '[email protected]' }
\`\`\`
特定语言的惯例
| 语言 | 代码块 | 安装包 | 环境变量 |
|---|---|---|---|
| JavaScript/Node | javascript 或 js | npm install | process.env.VAR |
| TypeScript | typescript 或 ts | npm install | process.env.VAR |
| Python | python 或 py | pip install | os.environ['VAR'] |
| Go | go | go get | os.Getenv("VAR") |
| Rust | rust | cargo add | std::env::var("VAR") |
| Shell | bash 或 shell | 不适用 | $VAR |
技术准确性检查清单
发布前逐项检查:
| 检查项 | 验证方法 |
|---|---|
| 代码可运行 | 复制粘贴每个代码片段并运行 |
| 版本匹配 | 使用的是当前库版本吗? |
| 链接有效 | 点击每个链接 |
| 命令可用 | 运行每条 CLI 命令 |
| 截图为最新 | UI 截图是否与当前产品一致? |
| 没有已弃用的 API | 检查是否使用了已弃用的 API |
| 安全审查 | 不包含硬编码密钥、SQL 注入等问题 |
| 同行评审 | 请工程师检查内容是否准确 |
面向开发者内容的 SEO
开发者使用 Google 的方式与普通消费者不同。
开发者搜索模式
| 模式 | 搜索示例 |
|---|---|
| 错误消息 | "TypeError: Cannot read property 'map' of undefined" |
| 如何操作 | "how to deploy next.js to vercel" |
| 比较 | "prisma vs typeorm 2024" |
| 最佳实践 | "typescript project structure best practices" |
| 替代方案 | "alternatives to firebase" |
| 搭配使用 | "react with typescript tutorial" |
技术 SEO 清单
| 元素 | 最佳实践 |
|---|---|
| 标题 | 包含主要关键词、框架名称,适用时加上年份 |
| 元描述 | 150 个字符,包含关键词,并承诺具体成果 |
| H1 | 与标题相同或高度相似 |
| H2 | 包含次要关键词,便于快速浏览 |
| 代码块 | 使用正确的语法高亮(有助于获得精选摘要) |
| 内部链接 | 链接到相关文档、教程和 API 参考 |
| 外部链接 | 链接到所提工具的官方文档 |
| URL 别名 | 使用小写字母和连字符,并包含关键词 |
优化标题示例
| 不佳 | 良好 |
|---|---|
| "使用我们的 API" | "如何使用 YourProduct API 进行身份验证(Node.js)" |
| "数据库指南" | "PostgreSQL 连接池:pgBouncer 完整指南" |
| "入门" | "YourProduct 入门:5 分钟内完成首次 API 调用" |
内容质量信号
优秀的开发者关系内容与平庸内容的区别:
请这样做
- 展示,而非空谈 — 多写代码,少写散文
- 说明“为什么” — 不仅说明如何操作,还要说明何时以及为何这样做
- 承认取舍 — 没有什么是完美的;开发者看重坦诚
- 链接到来源 — 官方文档、RFC 和相关文章
- 注明日期 — “2024 年 3 月更新”或版本号
- 循序渐进地呈现信息 — 从简单开始,逐步增加复杂度
- 提供真实示例 — 展示生产环境场景,而不只是 hello world
不要这样做
- 大段文字 — 用代码、标题和项目符号拆分内容
- 营销话术 — “同类最佳”“无缝”“革命性”
- 假定读者已具备相关知识 — 解释缩写,并链接到前置知识
- 内容过时 — 没有什么比一篇使用已弃用 API 的 2019 年教程更糟
- 重点埋得太深 — 先给出答案,再作解释
- 没有代码 — 开发者是为代码而来,不是为散文而来
内容模板
博客文章模板
# [Specific, keyword-rich title]
[2-3 sentence hook: problem + promise]
## The Problem
[1 paragraph explaining the pain point]
## The Solution
[Brief explanation of your approach]
### Step 1: [Action]
[Explanation]
\`\`\`language
// Code
\`\`\`
### Step 2: [Action]
[Explanation]
\`\`\`language
// Code
\`\`\`
### Step 3: [Action]
[Explanation]
\`\`\`language
// Code
\`\`\`
## Complete Example
\`\`\`language
// Full working code
\`\`\`
## Troubleshooting
### [Common Error 1]
[Solution]
### [Common Error 2]
[Solution]
## What's Next
- [Link to deeper dive]
- [Link to related tutorial]
- [CTA: Try it yourself]
对比文章模板
# [Tool A] vs [Tool B]: [Specific Use Case] ([Year])
[1 paragraph: Who this comparison is for and what you'll learn]
## Quick Comparison
| Feature | Tool A | Tool B |
|---------|--------|--------|
| [Feature 1] | | |
| [Feature 2] | | |
| [Feature 3] | | |
## When to Choose [Tool A]
- [Scenario 1]
- [Scenario 2]
- [Scenario 3]
## When to Choose [Tool B]
- [Scenario 1]
- [Scenario 2]
- [Scenario 3]
## Deep Dive: [Specific Aspect]
### Tool A Approach
[Explanation + code]
### Tool B Approach
[Explanation + code]
## Our Recommendation
[Specific guidance based on use case]
衡量内容成效
跟踪指标
| 指标 | 告诉你的信息 |
|---|---|
| 页面浏览量 | 覆盖范围(但脱离上下文便只是虚荣指标) |
| 页面停留时间 | 参与度(读者是否在阅读?) |
| 滚动深度 | 读者是否读到了结尾? |
| 跳出率 | 读者是否找到了所需内容? |
| 搜索排名 | SEO 表现 |
| 反向链接 | 权威性和参考价值 |
| 社交分享 | 内容共鸣度(尤其是 HN、Twitter、Reddit) |
| 转化事件 | 注册、安装、文档点击 |
内容 → 转化路径
跟踪用户历程:
- 搜索/社交平台 → 博客文章
- 博客文章 → 文档/快速入门
- 文档 → 注册/安装
- 注册 → 激活(首次成功)
工具
| 工具 | 用途 |
|---|---|
| Octolens | 监控内容在何处被分享(HN、Reddit、Twitter)。跟踪竞争对手的内容表现。从开发者讨论中寻找内容创意。 |
| Grammarly / Hemingway | 可读性和语法检查 |
| Carbon / Ray.so | 制作精美的代码截图 |
| Excalidraw | 技术图表 |
| Loom | 快速录制视频演示 |
| Ahrefs / SEMrush | 关键词研究和 SEO 跟踪 |
| Google Search Console | 跟踪搜索表现 |
相关技能
developer-audience-context— 了解读者的基础technical-tutorials— 深入了解分步内容developer-newsletter— 通过电子邮件分发内容developer-seo— 技术 SEO 优化hacker-news-strategy— 在 HN 上有效分享内容
评论
支持 Markdown