3.0 KiB
3.0 KiB
仓库说明
一句话概括
本仓库是河南理工大学人工智能协会的内部办事指南和知识沉淀中心。
为什么要有这个仓库?
协会日常运作中遇到几个痛点:
- 信息分散 — 制度文件在群文件,通知在聊天记录,办事流程靠口口相传
- 新人门槛高 — 大一成员不了解协会运作,不知道该找谁、能做什么
- 知识流失 — 技术分享和经验总结随成员更替而丢失
- 协作低效 — 博客投稿、活动策划缺乏统一的协作平台
这个仓库用 Git + Markdown 的方式解决以上问题:
- 版本控制:每份文档有完整修改历史,谁改的、什么时候改的、改了什么一目了然
- 纯文本:Markdown 文件任何编辑器都能打开,不依赖特定软件
- 本地 + 远程:Obsidian 提供沉浸式浏览体验,Git 提供远程同步和备份
仓库结构
Club-Service-Guide/
├── README.md # 仓库入口
├── CLAUDE.md # AI 助手配置
├── 仓库说明.md # 本文档
├── 导航页.md # 内容索引(MOC)
├── 办事指南/ # 各类办事流程
│ ├── 活动申请流程.md
│ ├── 经费报销流程.md
│ └── 场地预约.md
├── 制度文件/ # 协会规章制度
│ ├── 协会章程.md
│ ├── 部门职责.md
│ └── 考核标准.md
├── 通知公告/ # 协会正式通知
│ └── 人工智能协会内容创作通知.md
├── 会议纪要/ # 例会记录
├── 内容创作/ # 博客/公众号稿件
└── 技术分享/ # 学习笔记、经验总结
目录结构会随协会发展持续调整。
使用方式
方式一:Obsidian(推荐)
- 安装 Obsidian
- 「打开本地 vault」→ 选择本仓库根目录
- 享受双向链接、关系图谱、全文搜索
方式二:纯文本浏览
直接用任意文本编辑器打开 .md 文件阅读,或用 VS Code 获得 Markdown 预览。
方式三:Web 浏览
访问 协会 Gitea 在线查看仓库内容。
编辑规范
| 规范 | 说明 |
|---|---|
| 文件命名 | 使用中文描述性名称,如 活动申请流程.md |
| 标题层级 | 从 #(一级)开始,最多到 ###(三级) |
| 图片 | 直接复制粘贴到 Obsidian 中,或放入 附件/ 目录 |
| 链接 | 使用标准 Markdown 相对路径,如 [显示文本](路径/文件名.md) |
Git 工作流
# 编辑前先拉取最新
git pull
# 编辑完成后提交
git add .
git commit -m "docs: 更新活动申请流程"
# 推送到远程
git push
- 提交信息使用约定式提交格式:
docs: <描述>、feat: <描述>等 - 不删除他人文件,修改前先确认无人正在编辑同一文件