跳转至

致作者

如果你愿意向我们投稿,让 ReadMe 变得更加丰富多彩,更多地帮助同学们,请看一看接下来的投稿须知——

一、文档内容

稿件分为四类:课程笔记、作业攻略、技术分享、科创经验分享。

1. 课程笔记

我们期待你对课程内容的梳理,请以课程讲授的章节为单位提交。内容应为课程 PPT 及老师讲授内容的梳理,可以添加个人总结。注意,笔记需由本人梳理完成,不得直接照抄课件等。

我们鼓励提交培养方案内的必修、限选课程相关材料;也可以是其它课程,但请提前与科协负责同学沟通。

2. 作业攻略

作业攻略是指培养方案内课程作业的入门/保姆级教程,仅面向难度较大、要求较高的作业。预期成果是为同学指明方向,辅助同学理清思路,让同学更容易上手。在这里,我们期待你对高难度作业的复盘。

内容可以包括:所需技术栈,环境搭建,完成思路,相关软件的使用,异常处理办法,学习资料链接及总结等。其中,对环境搭建、相关软件的使用,应具体地说明操作步骤或提供参考文档。请不要包含任何形式的代码实现或答案。

3. 技术分享

该部分的定位是入门指导,不必是面面俱到的教材。

我们期待你对实用技术的介绍。只需要为我们厘清基础概念,说明技术作用,指明学习路线即可。课内技术的重点内容可以分章节叙述。对于课外技术,重点是让同学们知道技术的存在与其作用。内容建议包括:简述,重点概述,环境搭建,快速上手,资源链接等。

我们鼓励参考各类材料,但需注明出处。

二、投稿方式

请将稿件发送至院科协邮箱service@ssast.org

邮件主题格式:【ReadMe】+姓名+主题。

三、投稿要求

在投稿时,请务必遵守以下规范:

①投稿人需实名投稿,并注明在文档、致谢中使用真名或笔名。

②投稿时应提供联系方式、注明期望的志愿工时。

③使用 Markdown 格式编写需要提交的稿件。如果涉及图片或其他文件,可以组织成下面的结构后提交:

|-content.md
|-img
   |-img1.jpg
   |-...

(md文件和图片都需要打包上传,图片必须使用相对路径)

④ 如果稿件主题与已有稿件重合,请确保具有创新性,并在邮件中说明。

⑤ 稿件内容可以参考其它材料,但请注明出处。

我们尊重每一位作者的著作权。作者投稿即视作同意在 ReadMe 网站上发表稿件,授予软件学院学生科协修改权,允许他人在 ReadMe 网站下载稿件并进行二次创作。

五、奖励规则

1. 志愿工时

一篇文档的工时激励范围一般为 3-10h。对于特别优秀的文档,我们会予以更多的工时激励。我们将与投稿人协商确定工时。

2. 署名与致谢

我们将在网站首页致谢所有贡献者,你的名字也将出现在文档中。

3.加入作者团

投稿被采用后,作者均认定为 ReadMe 作者团成员,并发放纪念品。

4. 荣誉称号

每学期,我们将按照你的贡献度进行评奖,你有机会获得 ReadMe Fellow,ReadMe Member,ReadMe Associate Member 等荣誉称号哦。

本站总访问量

评论