项目介绍
项目概述
cssadoc(仓库名)是 BU CSSA 技术部的官方文档中心,站点标题为「BU CSSA 技术部文档站」。它将各子系统的使用说明、运维手册、新人指引集中在一个可搜索、可版本化的静态网站中。
项目定位
- 类型:静态文档网站(SSG)
- 读者:技术部 Admin / System / Member,以及需要查阅系统文档的其他成员
- 内容范围:规章制度、新人指引、各业务系统文档、服务器运维、历史成员档案、Blog
与其他系统的关系
文档站不运行上述业务系统,只提供说明与操作指南。页脚「相关链接」指向各系统线上地址。
内容组织原则
| 类型 | 典型目录 | 回答的问题 |
|---|---|---|
| Explanation | Overview / Developer Guide | 是什么、为什么 |
| Tutorial | Getting Started | 第一次怎么做 |
| How-to | User Guide / Deployment | 如何完成某任务 |
| Reference | API Reference / Configuration | 参数与配置查表 |
顶层导航分为:规章制度 → 新人必读 → 项目文档(各子系统)→ 服务器与运维 → 历史成员 → 术语表。
版本与语言
- 文档版本:支持
Current与V1.0切换(见导航栏版本下拉) - 界面语言:默认简体中文(
zh-Hans),支持英文(en)