贡献指南
施工中
欢迎来到 FreeODwiki!
本项目是一个开源开放的项目,致力于创建一个社区共建的OD百科。
参与流程
提交文档很简单,不需要电脑,手机就行。不涉及任何命令行操作,这里给一个简单的视频教程,点击这里查看。
点击这里查看官方发布的,如何通过Github网页端进行编辑的教程。
以下为涉贡献的文档名及其链接,如有疑问,请点击查看:
| 涉贡献文档 | 描述 |
|---|---|
| 本站精神 | 请确保你的编辑符合本站的精神和宗旨哦! |
| 如何做出你的第一个贡献 | 如果你想参与的话,这里有一个简单的教程哦! |
| 现有文件夹的描述 | 编辑时一定要看哦,免得搞混哪些文件夹是用来干什么的! |
| 文档翻译指南和提示词 | 如果你想从其他网站翻译文档,请务必看这个哦! |
| Markdown语法指南 | 如果你不太熟悉Markdown语法,请看这个哦! |
待完成的项目列表
如果你想参与一些正在进行的项目,这里有一个列表哦!
本页面包含本站尚未完成,但正在完成或准备开始的项目。
- OD史书 进度:[2023/2026] 有关历史的
- 配体 进度:[0/1] 有关生命科学的
- 愈美片 进度: [1/?] 有关药物制剂的
- 哮喘片 进度: [1/?] 有关药物制剂的
- 镁剂 进度: [1/?] 有关药物的
一般文档规范
编写规范
规范使用汉字及标点(如使用中文标点);
使用大写的OD;
一个文档的第一行一定是标题,如果有返回则放在标题的下一行;
文件夹的使用规范
对于每一类的文档,都需要用一个文件夹专门存储此类文档文件。除非真的有必要且不会引起歧义,否则不要在该文件夹里面再建文件夹,以减少无意义的嵌套。
若无必要,请勿增加文件夹的嵌套。
普遍框架
没有一个普遍框架就会让各个文档像是用固体胶粘起来的一样,或许阅读的各位可能有体会吧。
报告框架
# <你报告的标题>
[◀返回](./home.html)
拟定中...
建议大家投报告的pr的时候,最好在自己的报告的大标题下面第一行加一个返回箭头,就是[◀返回](./home.html)(直接复制粘贴就行)。
此外,还可以帮我们把整理的活给干了。就是在/报告/home.md中的索引部分的最后面,加上自己的索引- 你的报告标题(另建一行,直接复制粘贴就行)
文档维护指南
目录索引
目录是文档内的索引,具有告诉读者本文档有何内容的作用。如果目录缺失或者不对,请及时修正
超链接
超链接让文档内部与文档外部形成一个整体,让整个站点变得易于浏览。如果超链接有不对的地方,务必及时修正;如果一些本应有超链接的部分没有,请补上
文件内容
如果你发现文档的一个指向/文件/目录的文件缺失,请将相应的文件补上。
Markdown 和 HTML 规范
标题上下行留空;
不要留有超过一行的空行;
待补充...
感谢你的参与,让 FreeODwiki 更加完善!