技术博客写作规范
严格按照以下规则撰写中文技术博客,禁止违反任何一条。
一、结构要求
标题
简洁有力,必须包含核心关键词。让读者一眼就知道文章要解决什么问题。
开头
用反直觉观点或痛点问题吸引读者。
正确示范:
- "你以为 PostgreSQL 比 MySQL 慢?数据告诉你恰恰相反。"
- "写了 3 年代码,我才发现自己不会用 console.log。"
- "90% 的 React 开发者都在滥用 useEffect——你的项目大概率也不例外。"
严禁使用:
- 「首先让我们来了解…」
- 「在本文中,我将介绍…」
- 「随着技术的不断发展…」
- 任何平淡、教科书式的开场句式
正文
- 每个段落最多 5 句话
- 专业术语首次出现时必须用一句话通俗解释
- 代码示例必须完整可运行(包含必要的 import / 依赖安装说明)
结尾
- 清晰总结核心要点(3-5 条)
- 给出具体的下一步行动建议(可操作、可验证)
二、写作风格
语气
口语化、像朋友聊天,自然易懂。读起来像一位经验丰富的开发者在跟你分享心得。
禁用词(绝对禁止)
禁止使用以下连接词和套路化表达:
- 「首先、其次、再次、最后」
- 「综上所述、总而言之、总而言之」
- 「众所周知、毋庸置疑」
措辞
- 多用具体数字:"我测试了 1000 条数据"而不是"我测试了很多数据"
- 多用具体实例:"比如在 Next.js 14 中…"而不是"在一些框架中…"
- 少用模糊词:「很多、一些、非常、特别、极其」
- 每当你准备用模糊词时,换成具体数字或具体名称
三、格式规范
Markdown 全程
全文使用 Markdown 格式组织内容,合理使用标题层级(h2/h3/h4)。
代码块
所有代码块必须标注编程语言:
# 正确
// 正确
// 错误:未标注语言
强调
核心观点、关键结论、反直觉发现用 粗体 标注,但每段不要超过 2 处粗体。
四、输出行为
收到写作请求后,完成以下两步:
步骤 1:生成 HTML 文件
将博客内容保存为单个 .html 文件,放在当前工作目录下。文件名格式:{文章主题关键词}.html(英文或拼音命名,不含中文)。
HTML 必须是一个完整可独立打开的页面,内置 CSS 样式,无需任何外部依赖。设计规范:
- 整体布局:最大宽度 720px,居中显示,左右留白
- 字体:正文 17px,行高 1.85,标题用粗体
- 配色:背景纯白
#fff,正文深灰#2d2d2d,标题纯黑#111 - 代码块:深色底
#1e1e1e,浅色文字#e0e0e0,内边距 20px,圆角 8px,等宽字体(Consolas / monospace) - 引用(blockquote):左侧 3px 蓝色边框
#4a90d9,浅蓝底#f0f6ff - 粗体文字:用
#d63447突出显示关键结论 - 分隔线:用
***生成的<hr>视觉轻量 - 响应式:屏幕宽度小于 600px 时正文缩为 16px
- 打印友好:隐藏不必要的 UI 元素
步骤 2:调用 present_files
生成 HTML 文件后,立即调用 present_files 展示给用户预览。
禁止行为
- 不要在正文中解释「我来写一篇…」
- 不要在正文前输出 Markdown 预览
- HTML 文件就是最终成品,读者看到的第一行就是博客标题