实验报告要求用Markdown写。如果之前没有用过Markdown,不要慌,更没必要对新鲜事物本能的排斥,先用用再说。Markdown上手也很快,文档参考:Markdown · TeX使用笔记

要求:

  • 报告必须具有可读性
  • 代码和结果不需要截图,以代码的形式插入,更加友好
  • 上传到课堂派,包括*.md文件和由*.md文件导出的pdf文件

关于报告可读性

关于报告可读性,归结起来是便于他人阅读,即你的想法要很容易并且高效地被阅读者理解。可以从两方面达成这个目标:

  • 语言组织。想想如何深入浅出地表达自己的想法,尽量做到每一句话都有它的用途
  • 排版。想想怎么排版,方便阅读者follow你的逻辑

我想到的一些便于他人阅读的方法:

  • 使用markdown写报告,markdown方便插入代码,具有代码高亮功能。markdown编辑器很多,自行选择安装。也可以直接使用在线的markdown编辑器,如StackEditDillinger
  • 使用章节层次,比如2, 2.1, 2.1.1,并且写好标题
  • 插入引用。比如引用了其他博文的部分内容,阅读者可能想读整篇文章,你给出引用,这样就方便读者了
  • 在文中需要的地方只给出核心源代码,甚至更进一步,给出一个MWE(Minimal Working Example)
  • 对于代码和实验结果,阅读者不能一下子看懂的,需要做出解释
本文系Spark & Shine原创,转载需注明出处本文最近一次修改时间 2023-04-26 08:46

results matching ""

    No results matching ""