文档规范

本文档定义了项目文档的编写规范，适用于 docs/ 目录下的所有文档。

语言规范

• 主语言: 中文
• 技术术语: 使用英文原文 (如 API、JWT、Docker)
• 代码/命令: 使用英文

文件命名

• 使用 小写字母 + 短横线：quick-start.md
• 目录使用 编号前缀：01-getting-started/

文档结构

每个文档应包含：

# 标题

> 一句话简介

## 内容

正文内容...

## 相关文档

- [链接](path)

写作风格

1. 简洁明了：每段只表达一个观点
2. 以读者为中心：假设读者不熟悉项目
3. 使用主动语态：「运行命令」而非「命令被运行」
4. 提供示例：每个操作步骤附带示例

格式规范

元素	格式
代码/命令	反引号 `code`
文件路径	反引号 `path/to/file`
UI 元素	加粗 按钮名称
强调	加粗 重要内容
警告	使用 > [!WARNING] 块

链接规范

• 使用相对路径：../04-reference/api/auth.md
• 锚点使用小写：#section-name