通常我们提供包括但不限于 Markdown 格式的报告模板,以便于大家准确精炼地展示助教想要了解的信息。
如果你不使用我们提供的模板,你也需要参考我们提供的模板内容来组织你的报告。
无论我们提供何种格式的报告模板,或你自己选择的制作格式,你在提交时需要提交Markdown文件,推荐提交转换出的 PDF ,以便于助教查阅。
提交时你的目录结构应该是
|- report
|- report.md
|- report.pdf(optional)
|- imgs
|- img1.png
|- img2.png
我们有一些跨 lab 共通的报告要求:
- 不要贴大段的代码,你可以通过以下手段来避免:
- 使用伪代码
- 用注释替代一些不重要的部分
- 如果确实必要,请一小段一小段地复制,并配合文字解释
- 如果某段内容很长,请用“总分”的格式来组织,即先分点简述一下,再开始展开。同时,最好先讲你觉得最重要的部分。
- 不要写大段“助教知道”的内容,除非助教要求,比如解释非你修改/写的代码的内容。
- 尽量精简,不要用 AI 生成工具的车轱辘话来应付报告,我们宁愿你写得很短。
我们可能会于上机课上解释 Typora 的用法。但互联网上的资料已经足够丰富。
推荐Markdown Preview Enhanced插件,可以实时预览Markdown文件,但实际上vscode类似的插件有很多。
即便你不导出pdf也请自己先预览一下,以防助教在查看你的报告时有格式错误。