---
title: 文档总入口
doc_type: docs-index
domain: documentation
keywords:
  - 文档目录
  - docs
  - 约束入口
  - 业务沉淀
  - 功能文档
  - 运维文档
summary: 从大到小浏览整个仓库的文档结构、一级分类和推荐阅读顺序。
when_to_read:
  - 第一次进入 docs 目录，不确定该从哪类文档开始
  - 想确认某个主题应该归到哪一类文档
read_next:
  - ./constraints/README.md
  - ./business/README.md
  - ./overview/README.md
---

# 文档总入口

这篇文档只做一件事：告诉你现在的 `docs/` 是怎么分层的，以及不同问题应该先进入哪一个一级目录。

使用方式：

1. 先读这篇文档，确定问题属于哪一类。
2. 再进入对应一级目录的 `README.md`。
3. 最后再打开具体文档，不要一开始就扫全量正文。

## 一级分类

| 目录 | 这类文档解决什么问题 | 不该放什么 |
| --- | --- | --- |
| [`constraints/`](./constraints/README.md) | 项目级硬约束、编码规则、不能碰的边界 | 业务背景、运行手册 |
| [`overview/`](./overview/README.md) | 全局运行时结构、模块职责、系统分层 | 功能专项细节、测试步骤 |
| [`business/`](./business/README.md) | 长期稳定的业务知识、任务链路、业务口径、业务沉淀 | 一次性功能实现细节、功能测试步骤 |
| [`features/`](./features/README.md) | 功能专项设计、实现现状、专项对齐方案 | 稳定业务真值、运维 runbook |
| [`operations/`](./operations/README.md) | 启动补数、运维手册、功能测试、排障和人工验收 | 业务总览、全局硬约束 |
| [`bootstrap/`](./bootstrap/README.md) | 初始化包、导入导出、历史数据准备 | 业务流程、页面实现说明 |
| [`templates/`](./templates/README.md) | 文档模板 | 正式知识文档 |

## 怎么从大到小看

推荐顺序：

1. 全局约束：看 [`constraints/README.md`](./constraints/README.md)
2. 全局结构：看 [`overview/README.md`](./overview/README.md)
3. 业务真值：看 [`business/README.md`](./business/README.md)
4. 功能专项：看 [`features/README.md`](./features/README.md)
5. 运维和验证：看 [`operations/README.md`](./operations/README.md)
6. 初始化包：看 [`bootstrap/README.md`](./bootstrap/README.md)

## 按问题进入

| 如果你现在想做什么 | 建议先看 |
| --- | --- |
| 确认项目级约束和 fail-fast 边界 | [`constraints/README.md`](./constraints/README.md) |
| 看系统分层、模块职责和数据流 | [`overview/README.md`](./overview/README.md) |
| 看业务闭环、任务链路和数据拉取全貌 | [`business/README.md`](./business/README.md) |
| 看公告原文、公告解析、页面布局等专项方案 | [`features/README.md`](./features/README.md) |
| 跑功能测试、启动补数、运维排障 | [`operations/README.md`](./operations/README.md) |
| 做初始化包导入导出 | [`bootstrap/README.md`](./bootstrap/README.md) |
| 新建专项说明或测试文档 | [`templates/README.md`](./templates/README.md) |

## 根目录文档

- [`constraints/README.md`](./constraints/README.md)：项目级硬约束入口
- [`overview/README.md`](./overview/README.md)：全局结构入口
- [`business/README.md`](./business/README.md)：业务沉淀入口
- [`features/README.md`](./features/README.md)：功能专项入口
- [`operations/README.md`](./operations/README.md)：运维与验证入口
- [`bootstrap/README.md`](./bootstrap/README.md)：初始化包入口
- [`templates/README.md`](./templates/README.md)：模板入口
