内容摘要:我想大家都看过阿凡达,在电影里面杰克每天对着屏幕记录自己的生活,起初他觉得这种Video log很无聊,但这种工作方式对于科研很有用。因为人都会遗忘,特别是有时候为了装一个复杂的软件查阅了很多命令,好不容易装完了半年后计算机崩溃了,但是很多当时怎么装的忘了,这时候你会觉得当初记下来多好啊。今天我们就来讨论一下高效写日志的方法。
1、学会写日志
在科研过程中,离不开学习,无论是阅读文献,学习软件,还是撰写论文。很多时候你都要面对未知的东西。 在编程的时候,也要写文档,不写文档你的代码别人不会用,这样就失去了软件复用的价值。如果你是一个科学大V,你肯定有自己的Blog,写博客要通过网络传播,排版要美观才有人看吧!
所以,很多时候写日志是你生活中的常态,每天写一点,时间长了滴水可以汇成江海。特别是在你毕业的时候,导师让你做工作交接,这时候要有一套日志,你完全可以直接交给师弟师妹们,而不用在头疼回忆原来你们是怎么做的。学会写日志也成为,可重复科学研究过程的必备技能啦!
2、怎么写最高效
如果你不会觉得用Html写代码太麻烦,记不住Latex那么多命令,用记事本干堆文字,没格式,不好容易阅读,装个Word这种大软件,有时候感觉很笨重。对于很多科研人员、程序员等天天要大量敲字的键盘侠,非常流行采用Markdown的语法来写自己想要的日志。
Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写日志或者操作说明,现在很多博客平台都把支持Markdown语法。在Github的常用仓库中,你可以采用Markdown的语法来编写说明文档,并且以“README.md”的文件名保存在软件的目录下面。这样仓库会默认把这个文件的内容渲染好显示在下面。
Markdown的显示原理,还是要通过渲染变成Html,后台会通过语法规则,把你写的东西变成有个格式的Html后显示出来。所以,很多编辑工具都会有个预览,这个而过程就是渲染。
3、Markdown的用法
说起Markdown的语法啊,那是非常简单,总结起来也不过十来条。下面我们来看看吧。
- 黑体Bold: 前面两个星号 文本 后面两个星号 text
- 强调Emphasize: 前面一个星号 文本 后面一个星号text
- 链接Link: [标题] (地址)
- 内嵌代码Inline Code:反单引号 代码 反单引号
code
- 插入图片Image: ![名称] (地址)
- 列表List: * item
- 引用Blockquote: > quote
- 一级标题H1: # Heading
二级标题H2: ## Heading
三级标题H3: ### Heading
另外,需要注意的是要开启一个新段落的方法是 : 段落之间空一行。如果换行回车不行,插入换行符的方法是: 一行结束时输入两个空格。
除此之外,由于我们有了RStudio这样的神级编辑器,我们还可以快速将Markdown转化为演讲PPT、Word产品文档、LaTex论文甚至是用非常少量的代码完成最小可用原型。在数据科学领域,Markdown已经广泛使用,极大地推进了动态可重复性研究的历史进程。