Waltyou 的写作风格档案
Waltyou 的写作风格档案
1. 文章结构特点
1.1 前置元数据
使用 YAML Front Matter 格式
包含:layout, title, date, author, comments, categories, tags
日期格式:YYYY-MM-DD HH:MM:SS
分类和标签使用方括号数组格式
1.2 文章开头
简短引言 :1-3句话概括文章主题,语气轻松直接
阅读更多标记 :使用 <!-- more --> 分隔摘要和正文
目录 :使用 * 目录/Outline {:toc} 生成目录
1.3 正文结构
使用 Markdown 标题层级(#, ##, ###)
常用分隔线 --- 进行内容分区
喜欢使用表格进行对比和总结
代码块配合语言标识使用
2. 语言风格特点
2.1 语气与口吻
亲切自然 :像跟朋友聊天一样,使用”来了解一下”、”来看看”、”来看看是怎么回事”
实用导向 :强调”我们来看看怎么解决”、”直接上代码”
谦逊好学 :使用”来仔细看看”、”来了解一下”,体现探索精神
口语化表达 :”很酷很新颖”、”自己动手、丰衣足食”
2.2 句式特点
短句为主 :简洁明了,避免长难句
设问引导 :”为什么会…呢?”、”为什么要…呢?”
自问自答 :先提出问题,再给出解答
总结性语句 :段落末尾常有”总结一下”、”总之”
2.3 用词习惯
技术词汇准确 :专业术语使用规范
比喻生动 :”就像一个引擎的升级”、”有事找中间人”
连接词丰富 :”简单来说”、”首先”、”然后”、”另外”、”因此”
程度副词 :”非常”、”很”、”极大地”
3. 内容组织特点
3.1 技术文章结构
1. 前言/背景 - 说明为什么写这篇文章
2. 基础知识回顾 - 必要的概念解释
3. 核心内容 - 详细的技术讲解
4. 问题与思考 - 提出疑问并解答
5. 总结 - 归纳要点
3.2 讲解方式
由浅入深 :从基础概念逐步深入
图文并茂 :配合截图、流程图、架构图
代码示例 :提供可运行的代码片段
表格对比 :用表格整理对比信息
3.3 中英混合使用
中文为主,英文术语保留原样
英文标题常见于技术概念
代码注释和变量名使用英文
4. 特定表达方式
4.1 常用开场白
“继…之后,…”
“提起…,通常…”
“简单来说,…”
“…最近很火”
4.2 常用过渡语
“来仔细看看”
“来看看”
“来了解一下”
“先重温一下”
“让我们先…”
4.3 常用结束语
“总之,…”
“总结一下”
“这就是…”
“希望可以帮助大家”
4.4 引用方式
外部链接:[文字](链接) 格式
内部引用:[这里](../path) 或 [这里](https://waltyou.github.io/...)
图片引用:
5. 技术写作特点
5.1 问题驱动
以实际问题引出主题
描述遇到的问题和解决过程
分享踩坑经验和解决方案
5.2 实践导向
提供详细的步骤说明
包含环境配置和前置条件
给出验证方法和预期结果
5.3 深度与广度平衡
既有概念解释,又有源码分析
既有原理讲解,又有实践操作
适当引用官方文档和源码
6. 格式规范
6.1 代码块
使用三个反引号包裹
标注编程语言
关键代码会加注释说明
6.2 列表使用
有序列表用于步骤说明
无序列表用于要点罗列
嵌套列表用于层级关系
6.3 强调方式
使用 **粗体** 强调关键词
使用 *斜体* 较少
使用 > 引用 用于注意事项
7. 风格示例模板
中文技术文章模板
---
layout : post
title : 【技术主题】
date : YYYY-MM-DD HH:MM:SS
author : admin
comments : true
categories : [ 分类 ]
tags : [ 标签1 , 标签2 ]
---
简短介绍,说明这篇文章要讲什么。
<!-- more -->
---
* 目录
{:toc}
---
## 前言/背景
说明为什么要写这篇文章,遇到了什么问题,或者这个技术有什么值得关注的地方。
## 基础知识
### 1. 概念A
简单解释概念A是什么。
### 2. 概念B
简单解释概念B是什么。
## 核心内容
### 1. 主题一
详细讲解第一个主题。
``` 代码示例
// 代码注释
2. 主题二
详细讲解第二个主题。
对比项
方案A
方案B
特点1
…
…
特点2
…
…
问题与思考
在实践过程中可能会遇到的问题,以及背后的原理分析。
总结
英文技术文章模板
---
layout : post
title : English Title
date : YYYY-MM-DD HH:MM:SS
author : admin
comments : true
categories : [ Category ]
tags : [ Tag1 , Tag2 ]
---
Brief introduction about what this article will cover.
<!-- more -->
---
* Outline
{:toc}
---
## Background
Explain the context and why this article is written.
## Main Content
### 1. Topic One
Detailed explanation.
``` code
// code example
2. Topic Two
More details.
Conclusion
Summary of key points.
```
8. 个人特色总结
实用主义 :每篇文章都解决一个具体问题
循序渐进 :从基础到进阶,适合不同层次读者
经验分享 :不仅讲技术,还分享踩坑经验
结构清晰 :目录、标题、列表使用规范
语言亲和 :像技术朋友之间的交流,不居高临下
双语能力 :中英文文章都能写,根据主题选择语言