blog-writing-guide by getsentry/skills
npx skills add https://github.com/getsentry/skills --skill blog-writing-guide本技能确保每篇博文都遵循 Sentry 的博文写作标准——无论你是帮助工程师撰写第一篇博文,还是协助营销人员起草产品发布公告。
标准线: 每篇 Sentry 博文都应该是资深工程师愿意在团队 Slack 中分享,或在技术决策中引用的内容。
以下是需要内化并应用于每篇内容的核心原则。
我们的声音听起来像: 一位资深开发者在会议后的聚会上,真诚地解释他们真正感到兴奋的事情——聪明、具体、略带不羁、知识渊博。
我们的声音听起来不像: 企业博客、新闻稿、销售演示文稿或 AI 生成的摘要。
要做到技术精确、观点鲜明、直接了当。欢迎幽默,但应服务于内容,而非替代内容。讽刺手法可行。每篇博文有一个好笑话就足够了。
使用"我们"(指 Sentry)和"你"(指读者)。这是一场对话,而不是一篇论文。
切勿使用以下词语。它们是自动的危险信号:
开头必须做以下两件事之一:陈述问题 或 陈述结论。切勿以背景、公司历史或炒作开始。
好的例子: "在发布前两周,我们停用了整个指标产品。以下是为什么预聚合时间序列指标在调试时会失效,以及我们如何从头重建该系统。"
坏的例子: "在 Sentry,我们一直在寻找改进开发者体验的方法。今天,我们很高兴与大家分享我们指标产品的一些激动人心的更新,相信你们会喜欢。"
围绕读者实际想知道的内容来构建每篇博文,而不是你内部的叙事:
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
对于工程深度探讨,还需解决:5. 我们尝试过哪些行不通的方法?(建立信任)6. 已知的局限性是什么?(展现知识诚实)
弱标题: "背景"、"架构"、"结果"、"结论"
强标题: "为什么时间序列预聚合会破坏调试上下文"、"分布式 GROUP BY 的分散-聚集方法"、"此方案的失效点:基数墙"
用数字而非形容词。 如果你提出性能声明,请包含数字。
代码必须能运行。 如果博文包含代码,请测试它。包含导入语句、配置和上下文。注释应解释 为什么,而不是 是什么。
系统需配图。 如果你描述的系统包含两个以上交互组件,请包含图表。使用真实的服务名称进行标注,而不是通用的方框。
诚实胜过炒作。 切勿夸大功能的作用。承认局限性。如果某功能处于测试版,请说明。如果竞争对手在某方面做得好,可以指出。不要声称 AI 功能比实际更强大——"Seer 建议一个可能的根本原因" ≠ "Seer 找到了根本原因"。
标题是博文中影响力最大的句子。它必须能让开发者停止滚动浏览他们的 RSS 订阅源或 Twitter。
强标题 提出具体主张、讲述故事或承诺具体回报:
弱标题 是模糊的公告:
以有用的内容结束——文档链接、试用方法、征求反馈的呼吁。切勿以通用炒作("我们迫不及待想看看你构建了什么!")或对你刚说过内容的复述来结尾。
以下是按博文类型的快速对照表:
| 类型 | 目标 | 署名 |
|---|---|---|
| 工程深度探讨 | 解释技术系统/决策,供其他工程师学习 | 构建它的工程师。必须是。 |
| 产品发布 | 解释发布内容、其重要性以及使用方法 | 产品经理、工程师或开发者体验团队。除非是营销团队构建的,否则不是产品营销经理。 |
| 故障分析报告 | 包含时间线和修复方案的透明故障分析 | 工程领导层 |
| 数据 / 研究 | 来自 Sentry 独特数据视角的原创见解 | 数据团队、工程团队或研究团队 |
| 教程 / 指南 | 帮助开发者完成特定任务 | 开发者体验团队、工程师或社区贡献者 |
发布前自问:开发者会分享这篇博文吗?它有可能登上 Hacker News 吗?如果答案是否定的,那么这篇博文要么需要更多深度、更多原创见解,要么它应该放在更新日志里。
值得分享的博文至少包含以下一点:
请对照两个清单进行检查:
技术审阅:
编辑审阅:
最终检查:
提供反馈时,要具体且有建设性。引用薄弱段落,解释其薄弱之处,并重写以展示标准。
每周安装量
230
代码仓库
GitHub 星标数
458
首次出现
2026年2月25日
安全审计
安装于
codex216
gemini-cli215
cursor215
kimi-cli214
opencode214
github-copilot214
This skill enforces Sentry's blog writing standards across every post — whether you're helping an engineer write their first blog post or a marketer draft a product announcement.
The bar: Every Sentry blog post should be something a senior engineer would share in their team's Slack, or reference in a technical decision.
What follows are the core principles to internalize and apply to every piece of content.
We sound like: A senior developer at a conference afterparty explaining something they're genuinely excited about — smart, specific, a little irreverent, deeply knowledgeable.
We don't sound like: A corporate blog, a press release, a sales deck, or an AI-generated summary.
Be technically precise, opinionated, and direct. Humor is welcome but should serve the content, not replace it. Sarcasm works. One good joke per post is plenty.
Use "we" (Sentry) and "you" (the reader). This is a conversation, not a paper.
Never use these. They are automatic red flags:
The opening must do one of two things: state the problem or state the conclusion. Never start with background, company history, or hype.
Good: "Two weeks before launch, we killed our entire metrics product. Here's why pre-aggregating time-series metrics breaks down for debugging, and how we rebuilt the system from scratch."
Bad: "At Sentry, we're always looking for ways to improve the developer experience. Today, we're thrilled to share some exciting updates to our metrics product that we think you'll love."
Structure every post around what the reader is actually wondering, not your internal narrative:
For engineering deep-dives, also address: 5. What did we try that didn't work? (Builds trust) 6. What are the known limitations? (Shows intellectual honesty)
Weak: "Background," "Architecture," "Results," "Conclusion"
Strong: "Why time-series pre-aggregation destroys debugging context," "The scatter-gather approach to distributed GROUP BY," "Where this breaks down: the cardinality wall"
Numbers over adjectives. If you make a performance claim, include the number.
Code must work. If a post includes code, test it. Include imports, configuration, and context. Comments should explain why , not what.
Diagrams for systems. If you describe a system with more than two interacting components, include a diagram. Label with real service names, not generic boxes.
Honesty over hype. Never overstate what a feature does. Acknowledge limitations. If something is in beta, say so. If a competitor does something well, it's okay to note that. Do not claim AI features are more capable than they are — "Seer suggests a likely root cause" ≠ "Seer finds the root cause."
The title is the highest-leverage sentence in the post. It must stop a developer scrolling through their RSS feed or Twitter.
Strong titles make a specific claim, tell a story, or promise a specific payoff:
Weak titles are vague announcements:
End with something useful — a link to docs, a way to try it, a call to give feedback. Never end with generic hype ("We can't wait to see what you build!") or recaps of what you just said.
Here's the quick map by post type:
| Type | Goal | Byline |
|---|---|---|
| Engineering Deep Dive | Explain a technical system/decision so other engineers learn | The engineer(s) who built it. Always. |
| Product Launch | Explain what shipped, why it matters, how to use it | PM, engineer, or DevEx. Not PMM unless marketing built it. |
| Postmortem | Transparent failure analysis with timeline and fixes | Engineering leadership |
| Data / Research | Original insights from Sentry's unique data position | Data team, engineering, or research |
| Tutorial / Guide | Help a developer accomplish something specific | DevEx, engineer, or community contributor |
Before publishing, ask: Would a developer share this post? Does it have a shot at getting on Hacker News? If the answer is no, the post either needs more depth, more original insight, or it belongs in the changelog instead.
Posts worth sharing contain at least one of:
Run through both checklists:
Technical Review:
Editorial Review:
Final Check:
When providing feedback, be specific and constructive. Quote the weak passage, explain why it's weak, and rewrite it to show the standard.
Weekly Installs
230
Repository
GitHub Stars
458
First Seen
Feb 25, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykPass
Installed on
codex216
gemini-cli215
cursor215
kimi-cli214
opencode214
github-copilot214
新闻稿撰写工具:使用 inference.sh CLI 进行事实核查与专业新闻稿创作
7,400 周安装