跳到主要内容
版本:Current

项目介绍

项目概述

cssadoc(仓库名)是 BU CSSA 技术部的官方文档中心,站点标题为「BU CSSA 技术部文档站」。它将各子系统的使用说明、运维手册、新人指引集中在一个可搜索、可版本化的静态网站中。

项目定位

  • 类型:静态文档网站(SSG)
  • 读者:技术部 Admin / System / Member,以及需要查阅系统文档的其他成员
  • 内容范围:规章制度、新人指引、各业务系统文档、服务器运维、历史成员档案、Blog

与其他系统的关系

文档站不运行上述业务系统,只提供说明与操作指南。页脚「相关链接」指向各系统线上地址。

内容组织原则

站点文档按 Diátaxis 框架分类(详见 文档结构):

类型典型目录回答的问题
ExplanationOverview / Developer Guide是什么、为什么
TutorialGetting Started第一次怎么做
How-toUser Guide / Deployment如何完成某任务
ReferenceAPI Reference / Configuration参数与配置查表

顶层导航分为:规章制度新人必读项目文档(各子系统)→ 服务器与运维历史成员术语表

版本与语言

  • 文档版本:支持 CurrentV1.0 切换(见导航栏版本下拉)
  • 界面语言:默认简体中文(zh-Hans),支持英文(en