跳到主要内容

技术文档规范

1. 列表内容排版规范​

1.1 列表项结构​

  • 每个列表项由一个标记符（如 -、* 或 1.）开头，后接标题内容
  • 若该列表项包含扩展描述或子内容，应 换行显示，并 与标题文字左对齐（不是与符号对齐）

1.3 正确示例（内容对齐主列表标题）​

• UI 交互
  选中量子门列表的门显示默认参数，没有参数不显示。
  选中量子线路的门，显示当前选中门的参数。不同的量子门参数结构不一致。

1.4 错误示例：内容对齐符号​

• UI 交互
选中量子门列表的门显示默认参数，没有参数不显示。
选中量子线路的门，显示当前选中门的参数。

2. 标题序号规范​

标题应统一添加序号，便于文档结构清晰、内容定位和交叉引用。

2.1 序号格式​

  • 一级标题：使用阿拉伯数字，如 1.、2.、3.
  • 二级标题：使用阿拉伯数字加小数点，如 1.1、1.2、2.1
  • 三级标题：使用三位数字，如 1.1.1、1.1.2、2.1.1
  • 四级及以下标题：不建议使用序号，改用无序列表或其他组织方式

2.2 正确示例​

# 1. 项目概述

## 1.1 项目背景

## 1.2 技术架构

### 1.2.1 前端技术栈

### 1.2.2 后端技术栈