跳转至

写作约定

为了让这个站点后续可维护,建议从一开始就统一写法。

文件组织

  • 每个主题单独一个 Markdown 文件
  • 文件名尽量使用英文和短横线
  • 导航层级不要过深,优先保证可扫描性

标题层级

  • 一个页面只保留一个一级标题
  • 二级标题用于章节划分
  • 不要跳级使用标题

内容建议

  • 先写目标和适用范围
  • 再写前置条件、操作步骤和验证方式
  • 对命令、配置和路径使用代码块或反引号

推荐页面模板

# 页面标题

## 背景

## 前置条件

## 操作步骤

## 验证

## 常见问题