程序员如何记笔记_程序员笔记写在哪里-程序员宅基地

作为一个技术宅,很喜欢学习一些自己感兴趣的技术,在学习的过程中,深感记笔记非常的重要。对于成年人,记忆力比起年轻时候都会有不同程度衰减,由此记笔记尤甚重要。下面介绍一下这方面的心得。

笔记

笔记记得好,即使过上几年,再次翻看,还能记忆犹新。

笔记种类

从程序员的眼中,根据内容,笔记可以分为:

  • 信息。任何你想记录的。比如:服务器地址,账号/密码,知识点等。
  • 代码。好的代码易于阅读。代码本身也要求添加的足够的描述。有种说法,代码是最好的文档。
  • 文档。个人,项目或者团队的活动中的内容,包括项目需求,设计,开发,测试文档等。文档主要用于公司或团队内部进行知识交流的。
  • 交互文档。混合了代码,图表和文档。一般是类似jupyter notebook这种格式,它的特点是交互,体现了在开发过程中,逐步思考的过程。常用于技术学习和数据分析报告。
  • 文章。经过自己整理,总结,或者创作出的内容。相对正式,常用wiki,blog等发布。

对于一篇笔记,可以属于多个类别,比如:项目中的文档,可以通过blog单独发布出来,作为一篇文章分享给更多人。相对而言,交互文档会陌生一些,下面介绍一下。

交互文档:jupyter notebook, zeppelin

在学习Spark的时候,第一次接触了zeppelin,它是Web笔记形式的交互式数据查询分析工具,可以用scala和sql等语言展示数据,也可以用markdown来编写文档。这种代码,图表和文档混合的方式,真的感觉耳目一新。jupyter notebook也是如此,支持python, r, julia, and scala等40多种语言。下图中可以看到很多图表展示,和报表工具不同,在右上角的区域有可以修改的程序代码。这是一种专属于程序员的文档形式。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-LZtamLsn-1578559407559)(images/ApacheZeppelin_02.jpg)]


什么是好笔记

再来看看,什么是好的笔记应该有的特性。

  • 好理解: 好的笔记是容易理解的,对于要分享的笔记,尤其如此。
  • 易于复现: 常说,好的代码容易被测试,对于好的笔记,里面的内容也应该是容易被重现的,尤其是对于交互文档和文章中的内容。所以记笔记中,要记录环境如何安装,数据如何准备,程序如何运行,结果如何验证等。
  • 持续更新:好的笔记应该持续的更新出来的。

大家或许都看过廖雪峰老师的网站,写的很好懂。就像下图中所说“中文,免费,零起点,完整示例”。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Exq5uDal-1578559407567)(images/1557704516822.png)]

笔记的安全性

既然要分享,笔记的安全性非常重要。不同的笔记也有不同的发布范围。

  • Internet:
    • 公开。没有安全性限制,可以发布到internet上,让所有人访问。一般包括一些wiki,blog,开源代码等。
    • 私有。信息是私有的,但可以授权任意的人员来访问。个人的一些文章,代码,但并不想公开的,而且不含有公司的敏感信息。
  • 公司/部门:仅在公司/部门内部网络才可以访问。有些信息在公司或部门内部是公开的。比如:公司流程,部门policy等。
  • 项目:信息在项目组内部是公开的,可以授权项目外的同事来访问。比如:项目开发设计文档,源代码等。
  • 私有:信息是私有的,但可以授权公司的同事或者互联网上的朋友来访问。比如:个人的一些资料,文档,代码等。

工具

任何工具的流行,离不开需求,也离不开合适的环境。

历史

个人而言,使用的工具经历了以下的过程。

  • 原始社会:文本文件,word,excel文件
  • 工业时代:evernote, onenote, 有道云笔记
  • 信息时代:zeppelin,jupyter notebook + 思维导图
  • 互联时代: github(pages, wiki) + typora(markdown) + pandoc …

以上的这些时代的划分,纯粹是个人杜撰。

以上这些工具,我们都会混合使用,没有一种工具可以解决所有的问题。

原始社会:文本文件,word,excel文件

大家都是使用这些工具开始的,主要缺点是文件分散在计算机的各处,时间长了,放在哪里都忘了,查找起来很不方便。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7pS1CBmI-1578559407568)(images/ximg_5b6e4770e6897.jpg)]

工业时代:evernote, onenote, 有道云笔记

采用这些强大的工具,我们可以编写出如下图一样精美的笔记。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-zRvY9W68-1578559407569)(images/CNHome_Image1_v2.png)]

记不得从何时开始,用上了evernote,身边的很多朋友也在用onenote。用上这些工具,笔记集中管理,可以多级导航,搜索起来也很方便,应该说效率大大提高 。后来又开始使用有道云笔记,和evernote比起来,它可以编写markdown,笔记分级方便方便,但全文检索能力又不如evernote。

信息时代:zeppelin,jupyter notebook + 思维导图

虽然evernote,onenote等工具很强大,但无法执行程序代码。由此,zeppelin,jupyter notebook等工具孕育而生。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-oPMc6cUc-1578559407569)(images/jupyterpreview.png)]

思维导图

思维导图,则另辟蹊径,是表达发散性思维的有效图形思维工具。它运用图文并重的技巧,把各级主题的关系用相互隶属与相关的层级图表现出来,把主题关键词与图像、颜色等建立记忆链接。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-DTTnKxYZ-1578559407570)(images/1557381669838.png)]

互联时代: github pages+ typora(markdown) + jupyter notebook + pandoc …

面临的问题:

  • 工具的强大,造成笔记太多,如何使笔记更有价值?
  • 学习时记笔记,开发时写文档,需要展示时写ppt,如何用统一的方式来记录和分享呢?
分享

上面两个问题的答案或许是分享。知识的根本目的和价值是分享。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9SY1yzEb-1578559407571)(images/pic1_0.png)]

当需要分享知识的时候,往往会花上心思,这使得知识更易于理解,更加有价值。

整个知识分享的流程如下:

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/eipi10_microsheen/article/details/103911257

智能推荐

L1-014. 简单题_输出事实this-程序员宅基地

文章浏览阅读3.1w次。https://www.patest.cn/contests/gplt/L1-014这次真的没骗你 —— 这道超级简单的题目没有任何输入。你只需要在一行中输出事实:“This is a simple problem.”就可以了。#include <iostream>#include <cstdio>using namespace std;int main(){..._输出事实this

Multipathd Daemon was Unable to Set Options "fast_io_fail_tmo" or "dev_loss_tmo" Under UEK1 or RHCK_multipath rport failed to read dev_loss_tmo value -程序员宅基地

文章浏览阅读421次。Multipathd Daemon was Unable to Set Options "fast_io_fail_tmo" or "dev_loss_tmo" Under UEK1 or RHCK (文档 ID 1678794.1) APPLIES TO:Linux OS - Version Oracle Linux 5.7 with Unbreakable Enterprise Ker..._multipath rport failed to read dev_loss_tmo value error 2

Jython_Jython Development Tools (JyDT) for Eclipse_jythontools-程序员宅基地

文章浏览阅读729次。Installing JyDTThis section describes how to install JyDT by connecting to the JyDT update siteon the internet. If you have downloaded an update site to a computer on your network, please follow the_jythontools

验证结构中IMonitor的作用_验证 monitor组件的主要功能-程序员宅基地

文章浏览阅读922次。DUT 的 input 端口采用的monitor 是干嘛的呢?根据白书: 一,大型项目中,driver 根据协议发送数据,而monitor根据协议接收数据。如果driver和monitor由不同人实现,那么可以大大减少其中任意一方对协议理解的错误。二,便于复用???另外,我的一点理解是:用于判断是否真的将输入,打入了DUT。????就一般环境,IF与dri_验证 monitor组件的主要功能

kubernetes apiserver 报错 service-account-issuer is a required flag-程序员宅基地

文章浏览阅读1.8k次。k8s kube-apiserver 启动报错k8s 版本 1.24根据报错提示说的是是一个必须的参数我们来看一下这个参数是干啥的服务帐号令牌颁发者的标识符。 颁发者将在已办法令牌的 “iss” 声明中检查此标识符。 此值为字符串或 URI。 如果根据 OpenID Discovery 1.0 规范检查此选项不是有效的 URI,则即使特性门控设置为 true, ServiceAccountIssuerDiscovery 功能也将保持禁用状态。 强烈建议该值符合 OpenID 规范: https://_service-account-issuer

【CodeForces - 988C 】Equal Sums (思维,STLmap,STLset,tricks)_草莓^app^【755c.top】最新版-程序员宅基地

文章浏览阅读288次。题干:You are given kk sequences of integers. The length of the ii-th sequence equals to nini.You have to choose exactly two sequences ii and jj (i≠ji≠j) such that you can remove exactly one element ..._草莓^app^【755c.top】最新版

随便推点

Windows下Cygwin环境的Hadoop安装(4)- 在Eclipse中建立hadoop开发环境_hadoop class path 多个文件 cygwin-程序员宅基地

文章浏览阅读6.3k次。在使用hadoop的过程中,不可避免地遇到一些问题需要对hadoop代码进行改进,这就要求我们必须建立一个可修改hadoop代码的开发环境,下面的过程,我们就来建立一个基于Eclipse的hadoop开发环境。- 安装AntHadoop的编译需要Ant的支持,从这里下载并安装最新的Ant:http://ant.apache.org/bindownload.cgi。安装完成后,别忘了将_hadoop class path 多个文件 cygwin

VB:所有控件自适应窗口大小_控件随窗体大小变化改变 vb代码-程序员宅基地

文章浏览阅读1.1w次,点赞5次,收藏18次。Option ExplicitPrivate FormOldWidth As Long'保存窗体的原始宽度Private FormOldHeight As Long'保存窗体的原始高度'在调用ResizeForm前先调用本函数Private Sub ResizeInit(FormNameAs Form)Dim Obj As Control_控件随窗体大小变化改变 vb代码

Python学习笔记——pandas中get_dummies()的用法_python get_dummies-程序员宅基地

文章浏览阅读5.5k次,点赞5次,收藏14次。原文链接在此可以看到get_dummies默认就是所有变量都转了默认转了以后的变量用columns名_数值名表示其中参数predix:prefix : 给输出的列添加前缀,如prefix=“A”,输出的列会显示类似prefix_sep : 设置前缀跟分类的分隔符sepration,默认是下划线"_"df = pd.DataFrame([[‘green’ , ‘A’],[‘red’ , ‘B’],[‘blue’ , ‘A’]])pd.get_dummies(df,prefix = _python get_dummies

【政考网答疑】为什么公务员招录限制35岁以下?-程序员宅基地

文章浏览阅读934次。政考网每日一答,今日咱们讨论的问题是为什么公务员招录限制35岁以下?众所周知,无论是各地省考还是国考,均会要求考生年龄在18周岁以上、35周岁以下(应届硕士和博士经招录机关同意,可放宽到40岁),那么,公务员招录考试为何会限制35岁以下报考呢?这样的要求是否合理?1、高龄人员的可塑性相对不强相比较应届毕业生或者刚毕业不久的大学生,35以上的考生在身体素质上的优势并不明显,特别是一些基层岗位,条件艰苦,高龄考生的岗位匹配度相对较低。古语云,“三十而立,四十而不惑。”高龄考生已从过...

MySQL必知必会学习历程(一)_mysql编写新增教育经历-程序员宅基地

文章浏览阅读2.1k次,点赞5次,收藏27次。MySQL必知必会学习历程第1章 了解SQL1.1 关键术语介绍第2章 MySQL简介2.1 关键术语介绍2.2 安装mysql命令行实用程序(可选)2.3 安装mysql_community(最优)2.3.1 下载mysql_community2.3.2 安装过程第3章 使用MySQL3.1 连接到数据库3.2 建立样例数据库3.2.1 创建空的数据库3.2.2 下载样例表生成脚本3.2.3 使用样例表生成脚本3.3 选择数据库(USE)3.4 了解数据库和表(SHOW)3.5 命令及注释汇总第4章 检索_mysql编写新增教育经历

你都用 Python 来做什么?_你用python做什么-程序员宅基地

文章浏览阅读1.3w次,点赞42次,收藏158次。你们都用python做些什么呢?在开发中 python 这一个语言就像是小叮当,而 python 的第三方库则是“百宝箱”,你只要想着对某一个方向进行开发,那么这个“百宝箱”就会给你想要的东西。由于我是在开发多年后接触到的 python,对我来说自从接触 python 就打开了“新世界”的大门。(我正在求设计做一张图,还没做完,做完贴上在这里)一、做个自己玩游戏的程序在前几年,我有一个朋友是一个“游戏商人”,不过大多数他是手动进行商品处理。他有一天找到我,跟我说“嗨兄弟,会不会做外G?”!此时我_你用python做什么