如何阅读文档
本站是 BU CSSA 技术部的统一文档中心。
重要：刚加入、还在自学阶段的同学，不必先读「项目文档」。先把 新人指引、开发规范 和 学习资源 看完即可。认领项目或接 Issue 之后，再用本文和 系统一览 查具体系统。
站点顶层结构
intro / rules
├── 新人必读 ← 规章、规范、自学、系统菜单
├── 项目文档 ← 认领/接 Issue 后按需查阅
├── 服务器与运维 ← 基础设施（少数方向需要）
├── 历史成员
└── 术语表
侧边栏 项目文档 下按系统分栏：官网、门户、网盘、抽奖、GPT、Docs 等。每个系统有 index 首页和文档导航表。
子系统文档分类（Diátaxis）
| 侧边栏分类 | 类型 | 什么时候看 |
|---|---|---|
| 概览 | Explanation | 想了解系统是什么、架构怎样 |
| 入门指南 | Tutorial | 第一次在本机跑起来 |
| 用户指南 | How-to | 完成具体任务（界面、活动流程等） |
| API 参考 | Reference | 写代码时查接口 |
| 配置 | Reference | 查环境变量与配置项 |
| 部署指南 | How-to | 部署该应用（通常 eboard 或认领 infra 方向再看） |
| 开发者指南 | Explanation | 改代码前理解结构 |
| 故障排查 | How-to | 报错、调试 |
| 常见问题 | FAQ | 快速问答 |
| 参与贡献 | How-to | 开发环境、提 PR |
目录约定详见 CSSA Docs · 文档结构。
找什么，去哪里
| 你想做的事 | 去哪里 |
|---|---|
| 刚加入、还在自学 | 新人指引 → 学习资源 |
| 代码习惯、PR、AI 边界 | 开发规范与 AI 使用 |
| 认领/接 Issue 后不知道看哪 | 系统一览 |
| 开发某一系统 | 项目文档 → 该系统 → 参与贡献 / 开发者指南 |
| 活动当天操作抽奖等 | 项目文档 → 该系统 → 用户指南 |
| 共享服务器、域名 | 服务器与运维 |
| 写/改文档站 | CSSA Docs · 用户指南 |
组织级 vs 系统文档
- 组织级（
onboarding/、server/、rules.md）：整个技术部通用。 - 系统级（
systems/<系统名>/）：只描述该应用；以系统文档为准。
阅读建议
- 按需查，不必从 Overview 顺序读到 Contributing。
- 入门指南适合跟着做一遍；API / 配置适合当手册。
- 生产环境操作前看 部署指南、故障排查；新人默认本地 + PR。
- 标注 待补充 的段落，等 eboard 补全后再当唯一依据。