write-guide.md

Cipher's Blog 写作指导

一、文章结构规范

1.1 前言部分

• 每篇文章必须在开头包含清晰的前言或背景介绍
• 阐述写作动机和要解决的问题
• 说明文章的价值和意义

1.2 文章主体

• 使用层次分明的标题结构
• 首先介绍问题或概念
• 然后给出具体的解决方案
• 最后总结并提供延伸思考

1.3 总结部分

• 简要回顾文章核心内容
• 提供后续学习或实践建议
• 鼓励读者互动与反馈

二、内容风格指导

2.1 语言风格

• 使用简洁、直接的中文表达
• 避免冗长的描述，直击要点
• 保持技术专业性的同时兼顾可读性

2.2 技术深度

• 从实际应用出发，解决具体问题
• 提供完整的解决方案，而非片段式代码
• 包含必要的理论说明，但以实践为主

三、代码规范

3.1 代码示例

• 必须提供完整、可运行的代码示例
• 对于大型项目，可以分段展示并说明各部分功能
• 在关键代码段后添加解释和注意事项

3.2 代码格式

• 使用合适的代码语言标识符 (java, python, go, xml, shell, 等)
• 保持代码格式整洁，缩进一致
• 对重要逻辑添加注释

四、标签和分类

4.1 分类使用

• categories: 按主题分类 (如 ["技术"], ["web3"], ["区块链"] 等)

4.2 标签使用

• tags: 按具体技术或关键词标记 (如 ["java","spring-boot"], ["redis"], ["go"] 等)
• 标签和分类需准确反映文章内容

五、文章类型模板

5.1 技术教程类

• 背景介绍 → 问题分析 → 解决方案 → 代码实现 → 注意事项 → 总结

5.2 工具使用类

• 前言 → 问题 → 解决 → 完整代码 → 使用说明 → 总结

5.3 概念解析类

• 定义介绍 → 背景 → 应用场景 → 实现原理 → 实际案例 → 总结

六、写作要点

6.1 实用性

• 重点关注解决实际问题的能力
• 提供可操作的实践步骤
• 分享个人经验和最佳实践

6.2 结构性

• 保证文章结构清晰，易于查找信息
• 使用合适的标题层级
• 适当使用列表和要点来突出重点

6.3 完整性

• 提供从问题识别到解决方案的完整流程
• 包含必要的依赖和配置说明
• 考虑边界情况和异常处理

七、元数据格式

每篇文章必须包含以下frontmatter:

---
title: 文章标题
date: YYYY-MM-DDTHH:MM:SS+08:00
categories: ["分类"]
tags: ["标签1", "标签2"]
---

八、发布流程

1. 完成文章内容
2. 确认代码示例可运行
3. 完善标题、分类和标签
4. 校对文章内容的准确性和完整性
5. 保存至相应目录