最近在北京参加辕询老师的区块链开发课程。有幸被选为班长,我就需要整理课程笔记给大家使用。
但我独自整理了两次课的笔记之后,发现如果只由我一个人来整理笔记,会有几个问题:
错别字。自己很难看出来,但别人其实读一遍基本都能看出来,如果能随手改掉就好了。
听到同样的课程内容,不同知识水平的人的理解深度不同。我的知识有很多欠缺的地方,所以有部分内容我的整理会有偏差、错误。比如,我对 Windows 中编程相关的操作不熟悉,就需要熟悉的同学补充。
时间问题和重复劳动:近3个小时的课程,如果只由我自己整理,最快也要课后第二天下午才能整理完,这会耽误大家的使用。而除了我之外,肯定还有很多同学都在自己整理笔记,这其实也是某种程度上的重复劳动。
所以,我觉得应该采用一款云编辑工具,每次课程都选几个人一起尽快整理出一个初级版笔记,先供大家学习使用。
然后大家在这个基础上 都可以参与进来,特别是区块链的概念或编程知识比较丰富的同学,可以帮助修改、优化笔记。
可多人同时编辑,上课后当天晚上就可以整理好笔记,方便同学们使用。
所有愿意参与的人,之后都可以不断优化笔记。
有疑问的地方,或需要更丰富的知识才能讲清楚的地方,任何人都可以直接在笔记中相关位置用3个问号来提问,看到的同学如果能回答,可以直接在笔记中回答。如果最终有大家都不能解答的问题,可以集中起来向老师提问。
对工具主要有两个要求,最好都能满足:
- 可以多人同时编辑
- 能用于 Markdown 格式。因为是多人协作,使用Markdown 格式能更好地保持格式一致、层次清晰。
如果实在找不到满意的工具,只要先舍弃 Markdown 格式。
于是我开始搜寻各种工具,在这个过程中找到的比较好的工具:
石墨文档、腾讯文档:满足多人同时编辑,性能很好。但不支持Markdown格式。
gitbook:支持Markdown,但二级目录支持很差,有种想死的冲动。
HackMD: Markdown和多人同时编辑都支持,是我目前能找到的最合适我这个应用场景的工具。
去 HackMD 的GitHub地址查看,有三千多颗星,还不错。
HackMD 的使用方式也非常简单:先点击 https://hackmd-ce.herokuapp.com/ ,右上角点击登录,通过GitHub登录后。只需要新建文件,就会进入编辑页面。你只需要将编辑页面的网址发给协作者,他们就都可以进入编辑页面。大家就可以同时进行协作编辑。到目前为止,我用到的Markdown语法都是支持的。
唯一的缺点是,这个项目是部署在 heroku 上面的,所以访问速度不是那么好,且偶尔会断掉。但因为是开源项目,如果你觉得它特别符合你的要求,你可以部署到自己的服务器上用。
如果你知道更好的工具,也请推荐给我,哈哈。