跳转至

L2 示例 · 章节级长文

L2 适用场景

  • 单个产品的 Datasheet / 设计文档
  • 架构文档的某一章（如「前端架构 · 第 3 章 状态管理」）
  • API 接口说明
  • 90% 的内部文档都应该选 L2

1. L2 的视觉特征

  • 无 Hero 区（省空间、专注内容）
  • H1 标题下方有品牌加粗线（玫瑰金渐变）
  • 正文字号、行距与 L1B 一致
  • 侧边导航 + 右侧 TOC 全部保留

2. L2 的 frontmatter

---
title: 你的文档标题
description: 一句话说明
level: l2
category: product | arch | api | ops
status: draft | review | published
author: 作者
date: 2026-05-02
---

3. 典型结构建议

# 标题

!!! abstract "摘要"
    ...

## 1. 背景

## 2. 需求

## 3. 设计
### 3.1 架构图
### 3.2 关键决策
### 3.3 接口定义

## 4. 实现
### 4.1 核心算法
### 4.2 性能指标

## 5. 验收

## 附录

4. L2 示例正文片段

4.1 一个 Mermaid 图

graph LR
    A[输入信号] --> B[预处理]
    B --> C[XiAlgo-FX]
    C --> D[XiAlgo-NR]
    D --> E[输出]

    classDef node fill:#F5F2EA,stroke:#D4A574,stroke-width:2px
    class A,B,C,D,E node

4.2 一段代码

def build_chain(config: dict) -> 'xi.Chain':
    chain = xi.Chain(config['name'])
    for node in config['nodes']:
        chain.add(node['type'], **node.get('params', {}))
    return chain

4.3 一个 Admonition

性能约束

XiDSP-D2 的 MIPS 预算为 800，全链路算法占用不得超过 80%（640 MIPS）。 超出时编译器会报错并提示简化建议。

5. 何时不选 L2

场景 正确级别
整站/板块首页 L1A
产品矩阵、白皮书、规范 L1B
一个 bug 的备忘 L3
术语表某一个条目 L3
其余所有场景 L2