收录内容及规范
本项目主要采用GitBook生成文档,这是一款基于Markdown格式的文档编辑工具和托管平台。因此,为了方便阅读,我们制定了一些文件命名及内容上的规范,希望各位贡献者可以作为参考。
本规范只作为参考,您也可以按照自己的喜好对文件进行命名,但我们强烈建议您选择我们的命名规范。
本文档中介绍了课程分类方式以及文件夹构造,同时包括了以下收录内容的规范:
课程笔记
复习重点、资料
习题(课后习题、课外习题、小测)
作业(主要指论文、实验报告等项目)
课外学习资源
教学质量评价
课程学习方法分享
课程分类方式
本项目根据培养方案按照年级进行分类,文件结构类似于
├── 大一
│ ├── 动物生物
│ │ └── 具体内容...
│ ├── 微积分
│ │ └── 具体内容...
│ └── etc.
└── 大二
└── etc.
上传资源分类
在每一门课的文件夹中,会包含一下几个文件夹,每一门课程的文件夹中都会包含一个README.md
的文件,这个文件是用来提供文件下载地址,或包含有关内容的。
例如:
微积分
├── README.md
├── 习题
│ ├── 微积分II-2-期中考试
│ │ ├── 2014-2015-微积分II-2-半期试题+答案.pdf
│ │ ├── 2015-2016-微积分II-2-半期试题+答案.pdf
│ │ ├── 2016-2017-微积分II-2-半期答案.pdf
│ │ ├── 2016-2017-微积分II-2-半期试题.pdf
│ │ ├── 2017-2018-微积分II-2-半期试题+答案.pdf
│ │ ├── 2018-2019-微积分II-2-半期试题+答案.pdf
│ │ ├── 2019-2020-微积分II-2-半期试题+答案.pdf
│ │ └── 2020-2021-微积分II-2-半期试题+答案.pdf
│ └── 微积分II-2-期末考试
│ ├── 2015-2016-微积分II-2-期末答案.pdf
│ ├── 2015-2016-微积分II-2-期末试题.pdf
│ ├── 2016-2017-微积分II-2-期末答案.pdf
│ ├── 2016-2017-微积分II-2-期末试题.pdf
│ ├── 2017-2018-微积分II-2-期末答案.pdf
│ ├── 2017-2018-微积分II-2-期末试题.pdf
│ ├── 2018-2019-微积分II-2-期末答案.pdf
│ ├── 2018-2019-微积分II-2-期末试题.pdf
│ ├── 2020-2021-微积分II-2-期末答案.pdf
│ └── 2020-2021-微积分II-2-期末试题.pdf
├── 复习重点
│ └── 2022-微积分(II)-2-期末考试范围.pdf
├── 学习方法
├── 笔记
└── 课外资源
对于上传的资源,请将其放入对映的文件夹中,并在文件夹下的README.md
中加入下载链接,最好可以包括一个国内平台的下载链接(如阿里云)
在此之后,可以添加关于文件的说明
格式如下:
文件名:[github](github地址链接),[国内平台](地址链接),说明
笔记
笔记的文件名为
[授课时间]-[课程名称]-[笔记]-[上传者]
例如,小明在2023年上了微积分,则他上传的笔记应该命名为
2023-微积分-笔记-小明
若您希望匿名上传,则[上传者]
一处可以使用自定义的化名
复习重点
复习重点可以包括:老师勾画的重点或是知识点的总结
文件名为
[授课时间]-[课程名称]-[X]-[上传者]
其中,X=老师勾画重点、知识点总结
例如,小红在2023年上了动物生物学,老师勾画了重点,则她上传的重点应该命名为
2023-动物生物学-老师勾画重点-小红
习题
习题部分主要包括
课后习题-答案
课外习题-试题
考试、小测-试题
考试、小测-答案
课后习题
文件名为
[授课年份]-[课程名称]-[X]
其中,X=习题册名+章节+答案、章节+答案、第N次课后作业答案
如果您上传的是官方的习题册答案,请不要添加上传者;如果您上传的是自己写的答案解析,请添加上传者
例如,小明在2023年上微积分时,对微积分习题册第三章课后作业写了解析,则应该命名为
2023-微积分-第三章答案-小明
若他上传的是习题册的官方答案,则应该为
2023-微积分-习题册答案
课外习题
文件名为
[课程名称]-[习题册名]
考试、小测
文件名为
[考试年份]-[课程名称]-[X]
其中,X=期中考试、期末考试、第N次小测
例如,小红在2023年上了微积分,上传了2022年的期中考试试题,则应该命名为
2022-微积分-期中考试试题
若她上传的是2023年第3次小测的试题与答案,则应该为
2023-微积分-第3次小测试题与答案
课外学习资源
课外学习资源包括但不限于:网课、读物等。
有关学习资源的内容请添加于课外资源
的README.md
文件中。注意,请不要直接上传涉及版权争议的文件。
格式为
名称-[平台](网址)-贡献者:评价
例如,
**高等数学宋浩**-[b站](https://www.bilibili.com/video/BV1Eb411u7Fw/?spm_id_from=333.337.search-card.all.click)
-小明:学这个准没错
显示出来则为:
[
高等数学宋浩-b站
-小明:学这个准没错
]
若小红还想在这一个资料下方添加评论,则可以
**高等数学宋浩**-[b站](https://www.bilibili.com/video/BV1Eb411u7Fw/?spm_id_from=333.337.search-card.all.click)
-小明:学这个准没错
-小红:楼上说的对
[
高等数学宋浩-b站
-小明:学这个准没错
-小红:楼上说的对
]
作业
作业的文件名为
[授课时间]-[课程名称]-[X]-[贡献者]
其中X=大论文,第N次小论文,第N次实验报告
如果您有多个作业要提交,请直接提交文件夹,文件夹命名为
[授课时间]-[课程名称]-[作业]-[贡献者]
课程评价
课程评价
课程评价旨在帮助同学了解不同老师授课水平与风格,请在评价时尽量降低主观色彩的影响。
在每一门课的课程文件夹下,有一个名为课程评价
的文件夹,其中包含了一个README.md
文档,请在此文档中以表格的形式添加评价。
通常,表格的模板为:
204116020
02
85
优点:专业知识和能力非常强,对于课程内容的理解非常透彻,能够回答学生提出的问题并给予清晰的解释。缺点:上课有些时候缺少重点。
不会抽同学回答问题;每次都有拍照签到;偶尔有课堂练习;课后作业线上提交
上面的代码是
| 课程号 | 课序号 | 分数 | 教学水平 | 教学方法 |
|-------|-------|-----|---------|---------|
| 204116020 | 02 | 85 | 优点:专业知识和能力非常强,对于课程内容的理解非常透彻,能够回答学生提出的问题并给予清晰的解释。缺点:上课有些时候缺少重点。 | 不会抽同学回答问题;每次都有拍照签到;偶尔有课堂练习;课后作业线上提交 |
添加内容时,只需要在下面加入另一行代码即可,例如
| 课程号 | 课序号 | 分数 | 教学水平 | 教学方法 |
|-------|-------|-----|---------|---------|
| 204116020 | 02 | 85 | 优点:专业知识和能力非常强,对于课程内容的理解非常透彻,能够回答学生提出的问题并给予清晰的解释。缺点:上课有些时候缺少重点。 | 不会抽同学回答问题;每次都有拍照签到;偶尔有课堂练习;课后作业线上提交 |
| 你输入的课程号 | 你输入的课序号 | 你输入的分数 | 你输入的教学水平 | 你输入的教学方式 |
204116020
02
85
优点:专业知识和能力非常强,对于课程内容的理解非常透彻,能够回答学生提出的问题并给予清晰的解释。缺点:上课有些时候缺少重点。
不会抽同学回答问题;每次都有拍照签到;偶尔有课堂练习;课后作业线上提交
你输入的课程号
你输入的课序号
你输入的分数
你输入的教学水平
你输入的教学方式
学习方法
学习方法旨在帮助同学了解不同科目的学习方式,您可以在学习方法
文件夹下的README.md
中加入您认为的合适的学习方式。
包括但不限于:上课是否需要听课(还是上网课即可);记笔记利用什么方式(手写、打字、还是在书上做笔记);复习方式(总结、看笔记、思维导图、背)等
格式为:
小明:
不需要听课!
小红:
需要听课!
代码为:
---
贡献者姓名(若匿名则写匿名):
内容
最后更新于
这有帮助吗?