成都理工大学工程技术学院 生存指南 & 飞跃手册 - 内容设计框架文档
项目概述
本项目旨在为成都理工大学工程技术学院(以下简称"工程学院")的在校生和毕业生提供两个核心知识库:
- 生存指南:校园生活实用信息(入学、学业、校园生活、校园地图、周边探索等)
- 飞跃手册:升学与就业经验分享(考研、出国、就业/实习等)
参考项目:
- 南方科技大学飞跃手册 — VitePress 框架
- 上海交通大学生存手册 — GitBook 框架
- 上海交通大学飞跃手册 — Docsify 框架
内容版块划分
生存指南
| 序号 | 子模块 | 说明 | 状态 |
|---|---|---|---|
| 1 | 入学指南 | 报到须知、必备物品清单 | 待编写 |
| 2 | 学业相关 | 考试与备考、学分与绩点、图书馆使用指南、专业指南(后续可按专业细分) | 待编写 |
| 3 | 校园生活 | 宿舍生活、社团与学生组织、校园设施使用 | 待编写 |
| 4 | 校园地图 | 教学楼/系办/院办等功能场所标注及功能介绍 | 后续新增 |
| 5 | 周边探索 | 周边美食、旅游推荐 | 后续新增 |
| 6 | 常见问题 | FAQ | 待编写 |
飞跃手册
| 序号 | 子模块 | 说明 | 状态 |
|---|---|---|---|
| 1 | 考研 | 备考经验、院校选择、复试经验 | 待编写 |
| 2 | 出国 | 语言考试(雅思/托福)、选校与申请、文书写作、奖学金申请 | 待编写 |
| 3 | 就业/实习 | 简历与面试、行业分享、实习经验 | 待编写 |
| 4 | 个人总结 | 按院系/专业分类的经验帖 | 待编写 |
注:本校无保研资格,因此不设保研模块。
侧边栏结构
生存指南侧边栏
yaml
生存指南:
- 入学指南:
- 报到须知
- 必备物品清单
- 学业相关:
- 考试与备考
- 学分与绩点
- 图书馆使用指南
- 专业指南 # 后续可按专业细分
- 校园生活:
- 宿舍生活
- 社团与学生组织
- 校园设施使用
- 校园地图: # 后续新增
- 待规划
- 常见问题:
- FAQ
- 周边探索: # 后续新增
- 待规划飞跃手册侧边栏
yaml
飞跃手册:
- 考研:
- 备考经验
- 院校选择
- 复试经验
- 出国:
- 语言考试(雅思/托福)
- 选校与申请
- 文书写作
- 奖学金申请
- 就业/实习:
- 简历与面试
- 行业分享
- 实习经验
- 个人总结:
- 按院系/专业分类的经验帖内容管理策略
帖子组织方式
采用按主题分类 + 标签索引的方式:
- 一级目录:生存指南 / 飞跃手册
- 二级目录:具体主题(考研、出国、就业等)
- 标签:院系、专业、年份、去向等(通过 VitePress frontmatter 实现)
增删子模块操作指南
核心原则:目录结构即站点结构,添加内容无需修改代码配置。
| 操作 | 步骤 |
|---|---|
| 新增子模块 | 1. 创建新文件夹(如 docs/survival/library/)2. 添加 _category.md 定义标题和描述3. 添加内容 .md 文件 |
| 删除子模块 | 直接删除对应文件夹,构建时自动消失 |
| 重命名子模块 | 修改 _category.md 中的 title 字段 |
| 调整排序 | 修改 _category.md 中的 order 字段或各文件 frontmatter 中的 order |
| 移动内容 | 在文件系统中移动 .md 文件,更新 frontmatter 即可 |
目录约定与文件命名
docs/survival/academics/
├── _category.md # 分类元信息(标题、描述、图标、排序)
├── exam-tips.md # 具体内容文件
└── gpa-guide.md| 约定 | 说明 |
|---|---|
_category.md | 每个子目录的元信息文件,定义该分类的标题、描述、排序权重 |
| 文件名 | 使用英文短横线命名(kebab-case),简短且有意义 |
Frontmatter order | 控制同一目录内文件的排序(数字越小越靠前) |
Frontmatter title | 页面标题,同时用于侧边栏显示 |
Frontmatter 规范
生存指南文章
yaml
---
title: 报到须知
order: 1
description: 新生报到流程及注意事项
---飞跃手册文章
yaml
---
title: 2024级计算机专业考研上岸经验分享
author: 张三
department: 信息工程系
major: 计算机科学与技术
year: 2024
destination: 电子科技大学
type: 考研
tags: [考研, 计算机, 985]
date: 2024-06-15
---完整 Frontmatter 字段参考
yaml
---
# 基础信息(必填)
title: 页面标题
# 排序与分类
order: 1 # 同级排序权重,数字越小越靠前
category: 学业相关 # 所属分类
# 页面控制
sidebar: true # 是否显示侧边栏(默认 true)
outline: [2, 3] # 大纲显示层级
prev: /survival/ # 上一页链接
next: /survival/ # 下一页链接
# 内容元数据(飞跃手册文章建议填写)
author: 张三 # 作者(可匿名)
department: 信息工程系 # 院系
major: 计算机科学与技术 # 专业
year: 2024 # 毕业年份
destination: 电子科技大学 # 升学/就业去向
type: 考研 # 类型:考研 / 出国 / 就业
date: 2024-06-15 # 发布日期
# 标签与索引
tags: [考研, 计算机, 985]
# 页面行为
lastUpdated: true # 是否显示最后更新时间
description: 页面描述 # 用于 SEO 和搜索
---投稿流程
面向投稿者
- Git 熟悉者:Fork → 新建分支 → 参考模板编写 Markdown → 发起 Pull Request
- 不熟悉 Git 者:通过邮件提交 Word 文件,由维护者代为上架
面向维护者
- 收到投稿后,按模板格式整理为 Markdown 文件
- 放入对应目录,填写 frontmatter
- 提交 PR,CI 自动检查格式
- 审核内容后合并到主分支,自动部署上线
投稿模板
生存指南模板
markdown
---
title: {标题}
category: {分类}
order: 99
---
# {标题}
## 简介
<!-- 简要介绍这个话题 -->
## 正文
<!-- 详细内容 -->
## Tips
<!-- 实用小贴士 -->飞跃手册模板
markdown
---
title: {标题}
author: {作者}
department: {院系}
major: {专业}
year: {毕业年份}
destination: {去向}
type: {考研|出国|就业}
tags: []
date: {日期}
---
# {标题}
## 个人背景
<!-- 基本信息(可匿名) -->
## 准备过程
<!-- 备考/申请的详细过程 -->
## 经验总结
<!-- 核心建议 -->
## 踩过的坑
<!-- 值得注意的问题 -->视觉设计风格:简约 + 构成主义
风格定位
简约为基础,构成主义为点缀。 内容区域保持清晰可读,通过几何装饰元素、强调色、排版层次体现构成主义气质。
设计原则
| 原则 | 说明 |
|---|---|
| 内容优先 | 正文区域保持简洁,不因装饰牺牲可读性 |
| 几何点缀 | 在 hero 区域、分割线、卡片装饰中使用三角、圆形、对角线 |
| 对角线动感 | 标题装饰线、背景几何图案采用对角线构图 |
| 限定色板 | 主色深蓝 + 强调色红/橙 + 中性灰白 |
| 粗体无衬线 | 标题使用粗体无衬线字体,正文保持舒适阅读 |
色彩方案
css
/* 主色 - 深蓝系(沉稳、学术感) */
--color-primary: #1a237e;
--color-primary-light: #3949ab;
--color-primary-dark: #0d1642;
/* 强调色 - 红/橙(构成主义经典色) */
--color-accent: #d32f2f;
--color-accent-light: #ff6659;
--color-accent-dark: #9a0007;
/* 中性色 */
--color-bg: #fafafa;
--color-surface: #ffffff;
--color-text: #212121;
--color-text-secondary: #757575;
/* 暗色模式 */
--color-dark-bg: #121212;
--color-dark-surface: #1e1e1e;
--color-dark-text: #e0e0e0;构成主义装饰元素
- Hero 区域:对角线分割的色块、几何图形背景
- 分割线:斜线或几何图案代替普通水平线
- 卡片装饰:角落三角形、圆形标记
- 侧边栏:分类图标使用几何形态(三角、圆、方块)
- 首页 feature cards:不对称布局,几何背景图案
字体方案
css
/* 标题 - 粗体无衬线 */
--font-heading: 'Noto Sans SC', 'PingFang SC', -apple-system, sans-serif;
/* 正文 - 舒适阅读 */
--font-body: 'Noto Sans SC', 'PingFang SC', -apple-system, sans-serif;
/* 代码/标签 - 等宽 */
--font-mono: 'JetBrains Mono', 'Fira Code', monospace;已确认的设计决策
| 事项 | 决策 |
|---|---|
| 内容板块 | 生存指南:入学/学业/校园生活/校园地图(后续)/周边探索(后续)/FAQ;飞跃手册:考研/出国/就业/个人总结 |
| 暗色模式 | 支持(VitePress 默认主题自带) |
| 投稿模板 | 先用简单模板,后续迭代优化 |
| 最近更新列表 | 不需要 |
| 品牌素材 | 先用占位图,后续替换 |
待定事项
| 事项 | 状态 |
|---|---|
| 自定义域名 | 后续再考虑,先用默认 GitHub Pages 域名 |
| 贡献者展示页面 | 后续再考虑 |