文档规范
本规范供人类和 AI 共同遵守，确保知识库长期可维护、可检索。
文件命名
- 使用中文或英文均可，但禁止混用中英文空格
- 文件名应是内容的一句话摘要，不是分类标签
- 禁止在文件名中包含日期时间戳（如
2024_8_21 09_59_00） - 禁止在文件名中包含来源网站名（如
CSDN博客、掘金） - 系列文章用统一前缀 + 序号：
Binder机制(1)-驱动篇.md
# 好的命名
Android卡顿掉帧问题分析之工具篇.md
Perfetto使用指南.md
hwasan源码探究.md
# 差的命名
Liunx（概念篇）：Swap分区的作用-CSDN博客 (2024_8_21 09_59_00).md
文章结构
每篇 md 文件应包含 YAML frontmatter：
---
title: "文章标题"
tags: [性能, 内存, hprof] # 技术标签，用于检索
type: original | reference | case # original=原创, reference=外部参考, case=案例分析
created: 2026-05-13
---type: reference的文章必须在正文开头标注原文链接type: case的文章遵循案例模板（见下方）
案例模板
案例是知识库最有价值的部分。每个案例一个目录，放在对应板块的 cases/ 下：
performance/cases/
└── 2026-05-lockscreen-anr/ # 日期-简短描述
├── README.md # 案例分析文档（必须）
├── trace.perfetto-trace # 原始 trace（可选）
├── flamegraph.svg # 火焰图（可选）
├── screenshots/ # 截图（可选）
└── analysis-skill.md # AI 分析过程记录（可选）
案例 README.md 模板
---
title: "锁屏场景 ANR 问题分析"
tags: [ANR, 锁屏, Binder]
type: case
created: 2026-05-13
severity: P1 # P0-P3
device: "Xiaomi 15 Pro"
android_version: "Android 16"
status: resolved | investigating | workaround
---
## 现象
一句话描述问题表现和复现条件。
## 环境
- 设备/ROM 版本
- 复现率
- 触发场景
## 分析过程
按时间线记录关键分析步骤。引用 trace 文件和截图。
## 根因
一段话总结根本原因。
## 修复方案
代码变更或配置修改。
## 关联知识
链接到知识库中相关的原理文章。目录管理
添加新文章
- 确定文章属于哪个板块和子目录
- 如果是外部参考文章，放入
_references/而非正式目录 - 创建文章后，更新对应目录的
_index.md
添加新子目录
仅当某个主题积累了 5 篇以上文章时才新建子目录。少于 5 篇的放在对应板块的 misc/ 下。
_index.md 格式
每个主要目录应有一个 _index.md 作为该板块的导航索引：
# 板块名称
> 一句话描述本板块的范围
## 系列文章
- [系列名](相对路径) — 简短说明
## 独立文章
- [文章名](相对路径) — 简短说明
## 案例
- [案例名](cases/目录/) — 简短说明AI 协作规范
AI 添加内容时必须遵守
- 必须添加 frontmatter，包含 title、tags、type、created
- 必须将文章放入正确的目录，不得在根目录创建文件
- 必须更新对应
_index.md - 禁止修改
_private/下的内容 - 禁止删除已有文章，如需标记过时可在 frontmatter 添加
deprecated: true
AI 分析案例时的输出规范
当 AI 完成一次性能问题分析后，应将结果保存为案例：
- 在对应
cases/下创建日期命名的目录 - 按案例模板写 README.md
- 将 trace 文件、火焰图等附件放入同目录
- 如果使用了自定义 skill 进行分析，将 skill 调用记录保存为
analysis-skill.md
质量标准
| 指标 | 要求 |
|---|---|
| 原创文章 | 至少 100 行正文 |
| 外部参考 | 必须标注来源链接 |
| 案例分析 | 必须包含现象、分析、根因三个章节 |
| 配图 | 与 md 文件同目录或 screenshots/ 子目录 |
| 空壳文章 | 不允许（<10 行的文件应补充或移入 _archive/） |