文档仓目录结构说明
更新时间： 2026/09/28
在AtomGit上查看源码手册
文档中心有17本手册：快速入门、认识openUBMC、安装部署、构建升级、部件驱动接入、硬件适配、特性开发、接口定制、迁移、整机集成、测试验证、问题定位、社区贡献、常用工具、调试命令/工具、参考和常见问题，分别对应 docs 仓内 docs/zh/ 目录下的 getting_started、overview、installation、build_upgrade、component_driver、hardware、feature_dev、interface、migration、integration、testing、troubleshooting、contributing、common_tools、debug_tools、reference 和 general_faq 子目录。
文档仓手册相关目录结构示例如下：
text
├─docs
│ ├─tools <!-- 工具文档，包含：IPMI文档工具（check_format.py和update_index.py） -->
│ ├─en
│ └─zh
│ ├─getting_started <!-- 手册：快速入门 -->
│ ├─overview <!-- 手册：认识openUBMC -->
│ ├─installation <!-- 手册：安装部署 -->
│ ├─build_upgrade <!-- 手册：构建升级 -->
│ ├─component_driver <!-- 手册：部件驱动接入 -->
│ ├─hardware <!-- 手册：硬件适配 -->
│ ├─feature_dev <!-- 手册：特性开发 -->
│ ├─interface <!-- 手册：接口定制 -->
│ ├─migration <!-- 手册：迁移 -->
│ ├─integration <!-- 手册：整机集成 -->
│ ├─testing <!-- 手册：测试验证 -->
│ ├─troubleshooting <!-- 手册：问题定位 -->
│ ├─contributing <!-- 手册：社区贡献 -->
│ ├─common_tools <!-- 手册：常用工具 -->
│ ├─debug_tools <!-- 手册：调试命令/工具 -->
│ ├─reference <!-- 手册：参考 -->
│ └─general_faq <!-- 手册：常见问题 -->目录
各手册下均有具体的目录划分。以部件驱动接入手册为例，其进一步细分为部件驱动接入导读、概念原理、快速上手、总体指导等一级目录。
文档仓部件驱动接入目录结构示例如下：
text
├─docs
│ ├─tools <!-- 工具文档，包含：IPMI文档工具（check_format.py和update_index.py） -->
│ ├─en
│ └─zh
│ └─component_driver <!-- 手册：部件驱动接入 -->
│ ├─concept_principle <!-- 一级目录：概念原理 -->
│ ├─general_guide <!-- 一级目录：总体指导 -->
│ ├─nic_adapt <!-- 一级目录：网卡适配 -->
│ ├─hdd_adapt <!-- 一级目录：硬盘适配 -->
│ ├─xpu_adapt <!-- 一级目录：xPU适配 -->
│ └─fan_power_adapt <!-- 一级目录：风扇电源适配 -->部分一级目录会进一步细分出二级目录，以部件驱动接入手册中的总体指导目录为例，其下进一步划分出二级目录，分别为网卡驱动规范、南向网卡驱动适配指南、openUBMC Studio网卡适配指南等。
文档仓服务器下特性开发的目录结构示例如下：
text
├─docs
│ ├─en
│ └─zh
│ ├─getting_started <!-- 手册：快速入门 -->
│ ├─overview <!-- 手册：认识openUBMC -->
│ ├─installation <!-- 手册：安装部署 -->
│ ├─build_upgrade <!-- 手册：构建升级 -->
│ ├─hardware <!-- 手册：硬件适配 -->
│ ├─component_driver <!-- 手册：部件驱动接入 -->
│ ├─concept_principle <!-- 一级目录：概念原理 -->
│ ├─general_guide <!-- 一级目录：总体指导 -->
│ ├─nic_adapt <!-- 一级目录：网卡适配 -->
│ ├─nic_driver_spec <!-- 二级目录：网卡驱动规范 -->
│ ├─south_nic_driver_adapt <!-- 二级目录：南向网卡驱动适配指南 -->
│ └─studio_nic_adapt <!-- 二级目录：openUBMC Studio网卡适配指南 -->文档
每本手册分别对应文档仓的一个文件夹。每本手册包含一个或多个文档内容文件（.md文件）。
文档仓服务器下快速入门手册的文档目录结构示例如下：
text
├─docs
│ ├─tools <!-- 工具文档，包含：IPMI文档工具（check_format.py和update_index.py） -->
│ ├─en
│ └─zh
│ ├─getting_started <!-- 手册：快速入门 -->
│ ├─explore_openubmc.md <!-- 文档：探索openUBMC -->
│ ├─quick_start <!-- 文档：openUBMC快速入门 -->
│ ├─env_introduction.md <!-- 文档：开发环境快速搭建 -->
│ ├─build_your_own_bmc.md <!-- 文档：构建你的BMC -->
│ ├─document_intro.md <!-- 文档：文档导读 -->
│ └─glossary.md <!-- 文档：术语表 -->
│ ├─overview <!-- 手册：认识openUBMC -->
│ ├─installation <!-- 手册：安装部署 -->
│ ├─build_upgrade <!-- 手册：构建升级 -->