博客写作技能

本技能帮助你以廖雪峰的标志性写作风格创作技术博客和教程。

核心风格特征

廖雪峰的写作风格具有以下鲜明特点:

•亲切友好 - 面向初学者,降低技术门槛
•循序渐进 - 从简单到复杂,层层递进
•类比丰富 - 用生活例子解释技术概念
•实践导向 - 强调动手操作,包含练习
•逻辑清晰 - 问题→原理→例子→练习
•短句为主 - 避免长难句,易于理解

快速开始

基本工作流程

•
明确文章类型和目标读者
- •是概念讲解?工具对比?实践教程?
- •读者是完全初学者还是有一定基础?
•
选择合适的模板
- •查看 references/article-templates.md 选择模板
- •5种常见模板覆盖大多数场景
•
应用写作框架
- •使用 references/writing-framework.md 的结构规律
- •遵循逻辑展开模式和句式节奏
•
运用标准语句库
- •参考 references/phrase-library.md 获取地道表达
- •保持语气一致性
•
质量检查
- •对照框架检查结构完整性
- •确保符合风格特征

详细指南

文章结构设计

每篇文章遵循标准三段式:

•引入段 - 提出问题或场景,激发兴趣
•展开段 - 层层递进讲解,原理→例子→实践
•总结段 - 回顾要点,鼓励实践

章节组织原则:

•每个大节解决一个核心问题
•小节控制在3-7个
•使用数字编号(1.1, 1.2)建立层次
•每小节200-500字

逻辑展开方法

根据内容选择合适的展开模式:

问题驱动型: 为什么需要→痛点→解决方案→例子→总结

对比递进型: 传统方法→局限→新方法→对比→适用场景

层层深入型: 最简单情况→增加复杂度→实际场景→完整例子→规律总结

详见 references/writing-framework.md 的"逻辑展开模式"部分。

语言和语气

关键原则:

•短句为主(单句<25字)
•每2-3段提出一个问题
•关键概念重复3次以上
•使用"我们"而非"你们"

典型句式组合:

•提问句(引思考)
•陈述句(给答案)
•举例句(具体化)
•对比句(深化理解)
•总结句(强化记忆)

查看 references/phrase-library.md 获取完整的常用句式库。

例子编写规范

好的例子必须具备:

•场景具体 - 不说"处理数据",说"统计学生成绩"
•代码简短 - 核心代码<10行
•结果可见 - 必须有输出/效果展示
•循序渐进 - 从错误示例→正确示例

标准例子模板:

code

假设我们要[具体任务]。

错误的做法:
[代码 - 常见错误]

正确的做法:
[代码 - 正确方法]

注意到区别了吗?关键在于[核心差异]。

术语处理

•
首次出现: 中文解释 + 英文原词
- •示例:"函数(function)就是可重复使用的代码块"
•再次出现: 只用中文
•重要术语: 加粗或代码格式
•避免: 术语堆砌,假设读者有背景知识

类比和比喻

用生活例子解释技术概念:

•变量 → 盒子(存放东西)
•函数 → 工具箱/榨汁机
•循环 → 重复做某事
•数组 → 排队的人
•条件判断 → 岔路口

使用"想象""就像""可以把它理解为"等引导词。

练习设计

每篇教程应包含练习:

特征:

•紧扣本节核心知识点
•难度略低于讲解内容
•有明确验证标准
•使用鼓励性语言

模板:

code

现在轮到你了!

**练习**: [任务描述]

提示:
- 第一步: [具体指导]
- 第二步: [具体指导]

完成后,如果看到[预期结果],说明你做对了!

参考文档

本技能包含三个详细的参考文档:

writing-framework.md

完整的写作框架,包括:

•文章整体结构规范
•逻辑展开的3种模式
•句式节奏控制方法
•解释技术的通俗化策略
•例子和练习的编写规范
•标题命名规则
•代码呈现规范
•开头和结尾设计

何时查阅: 规划文章结构、不确定如何展开逻辑时

phrase-library.md

按使用场景分类的常用句式库:

•开场引入句式
•解释说明句式
•强调提示句式
•举例说明句式
•过渡衔接句式
•互动引导句式
•鼓励肯定句式
•总结回顾句式

何时查阅: 需要标准表达、过渡不自然、语气不够亲切时

article-templates.md

5种文章类型的完整模板:

•技术概念讲解型(解释新概念)
•工具/技术对比型(比较方案)
•实践教程型(手把手教学)
•问题解决型(解决具体问题)
•快速入门型(快速上手工具)

每个模板包含:

•结构框架
•实例演示
•使用说明

何时查阅: 开始写作前选择合适模板

写作流程示例

示例任务: 写一篇"什么是API"的文章

第1步: 确定文章类型

•这是概念讲解型文章
•目标读者: 完全初学者

第2步: 选择模板

•查看 article-templates.md
•选择"模板1: 技术概念讲解型"

第3步: 规划结构 按模板结构:

•什么是API?(定义+类比)
•API的工作原理(分步讲解)
•常见问题
•实践练习
•小结

第4步: 撰写内容

使用 phrase-library.md 中的句式:

•开头: "在学习编程时,你一定听说过API这个词..."(开场引入)
•定义: "API是什么?简单来说,API就是..."(概念定义)
•类比: "这就像餐厅的菜单一样"(类比说明)
•过渡: "接下来,我们看看API是如何工作的"(递进关系)
•强调: "注意: 这里是关键"(重点强调)
•练习: "现在轮到你了!"(动手引导)

应用 writing-framework.md 的原则:

•短句为主
•每段提问题
•逐步深入
•包含错误→正确示例

第5步: 质量检查

检查清单:

风格控制参数

根据不同需求调整风格细节:

亲切程度

•高: 频繁使用"很简单"、"不用担心"、互动提问
•中: 保持友好但更专业,减少口语化
•低: 仅保持清晰,减少鼓励性语言

例子密度

•高: 每个概念2-3个例子,包含错误示例
•中: 主要概念1个例子
•低: 仅关键概念有例子

详细程度

•高: 每个步骤都详细解释,包含常见问题
•中: 核心步骤详细,次要步骤简略
•低: 仅展示主流程,省略细节

实践强度

•高: 多个练习,包含提示和答案
•中: 1-2个练习,有基本引导
•低: 仅建议读者实践,无具体练习

默认配置: 亲切程度=高,例子密度=中,详细程度=高,实践强度=中

常见场景处理

场景1: 解释复杂技术概念

策略:

•先用一句话给出最简定义
•用生活类比建立初步认知
•分3步递进讲解(简单→进阶→实际)
•每步都有代码示例
•对比相关概念加深理解

场景2: 对比多个技术方案

策略:

•先说明问题背景和选择的重要性
•分别介绍每个方案(定义+特点)
•用同一任务展示不同实现
•总结各自适用场景
•给出明确的选择建议

场景3: 手把手教程

策略:

•明确学习目标和前置条件
•每步都包含: 说明+代码+输出+注意事项
•提供常见问题排查
•包含验证步骤
•给出进阶方向

质量标准

优秀的廖雪峰风格文章应该:

结构方面:

•逻辑清晰,层次分明
•每节有明确目的
•过渡自然流畅

内容方面:

•概念解释通俗易懂
•例子具体可执行
•包含实践环节
•覆盖常见问题

语言方面:

•短句为主,节奏明快
•语气亲切友好
•鼓励读者实践
•避免术语堆砌

技术方面:

•代码正确可运行
•遵循最佳实践
•版本信息明确
•示例贴近实际

注意事项

应该做的

•从读者角度思考,预判困惑点
•用通俗例子降低理解门槛
•提供可运行的完整代码
•鼓励读者动手实践
•保持积极正面的语气

不应该做的

•假设读者有背景知识
•使用长难句和复杂从句
•术语堆砌,缺少解释
•示例过于抽象或不完整
•语气生硬或过于专业

快速检查清单

写完文章后,逐项检查:

开头:

• 提出了明确的问题或场景
• 说明了学习价值

主体:

结尾:

• 总结了核心要点(2-3条)
• 鼓励读者实践
• 指出了后续学习方向

整体:

• 语气亲切友好
• 包含互动提问
• 有实践练习或验证步骤
• 标题清晰明确

示例调用

调用示例1: 基础概念讲解

输入:

code

使用廖雪峰风格,写一篇文章讲解"什么是闭包"。
目标读者: 有JavaScript基础但不了解闭包的初学者。

预期输出:

•使用"技术概念讲解型"模板
•开头用生活类比(比如"保险箱")
•分3步递进: 最简单的闭包→带参数→实际应用
•每步有可运行代码示例
•对比闭包和普通函数
•包含常见问题(如内存泄漏)
•结尾有练习题和总结

调用示例2: 技术对比

输入:

code

用廖雪峰风格对比React和Vue,帮助读者选择。
亲切程度=中,详细程度=中。

预期输出:

•使用"工具/技术对比型"模板
•开头说明选择框架的重要性
•分别介绍React和Vue的特点
•用同一个Todo应用展示代码差异
•清晰总结适用场景
•给出选择建议
•语气专业但友好

调用示例3: 实践教程

输入:

code

写一个廖雪峰风格的教程: 从零搭建Express应用。
包含完整步骤,实践强度=高。

预期输出:

•使用"实践教程型"模板
•明确列出准备工作(Node.js版本等)
•每步包含: 命令+输出+说明
•提供常见错误排查
•包含验证步骤
•多个练习题带提示
•给出进阶方向

总结

使用本技能写作时:

•先选模板: 根据文章类型选择合适模板
•查框架: 规划结构和逻辑展开方式
•用句库: 保持语气和表达的一致性
•重检查: 对照清单确保质量

记住廖雪峰风格的核心: 让初学者也能轻松理解技术,并愿意动手实践。

所有具体的规律、句式和模板都在参考文档中,需要时随时查阅。