程序员读技术类书籍如何做笔记? - 知乎
我是如何写好一篇技术博客的 - 简书
技术博客,该写些什么? - 知乎
前言
最近翻翻以前的博客和笔记,都觉得写的不好。工作这么多年,其实一直都有想做成知识系列或者出书的打算,一方面是专业知识差了些,一方面就是笔记文笔写的不好。抽了点时间,专门写篇文章研究一下程序员如何写技术博客。
目录
一、写作之前
1.写作目标
2.写作内容
二、写作之中
1.列出提纲和主要观点
2.按模板顺序行文
三、写作之后
1.优化文章内容和观点
2.优化标题
3.优化前言和总结
4.优化排版
四、总结
附录:写作模板
一、写作之前
在阅读技术类书籍时,做笔记是一个非常重要的技能,可以帮助我们更好地理解和记忆所学内容。
1.写作目标
明确目的:在开始阅读之前,明确做笔记的目的,有助于有针对性地进行笔记。
通常有两种目的:
1)加深理解、记忆关键概念、备忘重要步骤。选择泛读即可,将关键点记录下来;
2)实践和应用。建议泛读一遍,再仔细通读一遍。泛读时找到你感兴趣的内容,仔细通读时则记录笔记,为实践和应用打下基础。
明确类型:在笔记写作前,需要明确受众群体,有助于针对性进行阅读。
通常的技术文章题材有3种:
1)技术介绍类
从实用角度介绍新技术,风格类似技术文档,面向技术小白,目标是达到即学即用。
举例:https://www.jianshu.com/p/66b93df4b7a6
2)技术深入类
从原理角度深入分析某项技术,面向技术中级,目标是通俗易懂。
举例:https://blog.csdn.net/guolin_blog/category_9268670.html
3)解决问题类
从实际问题出发给出解决方案,面向遇坑开发者。
2.写作内容
1.) 使用关键词和短语:抓住关键词和短语,尤其是技术术语和重要概念。将它们记录下来,并在旁边加上自己的理解或关联的信息。
2.)维护结构化笔记:使用清晰的标题和子标题来组织你的笔记,确保它们具有结构性。这样做有助于后续的复习和查找。
3.) 实践和示例:如果书中包含实际的代码示例或案例研究,将它们记录下来,并尝试在自己的开发环境中实践。在笔记中标注关键的代码片段和解释。
4.) 使用图表和图像:如果书中包含图表、图像或表格,尝试在笔记中重绘或描述它们。这有助于加深对视觉信息的理解。
5.) 个人注解和想法:在适当的地方,添加自己的注解和想法。这有助于将书中的概念与你自己的经验联系起来,并提高记忆的粘性。
二、写作之中
1.前言和目录
前言的意图在于告知文章方向及受众人群。对于问题类,直接列出要解决的问题。
目录可以使用脑图或书本目录
2.列出提纲
提纲的目的在于观点逻辑的完整性及重点部分
3.写作手法
总分总
4.引用链接
引用他人文章时,文末或文中添加链接。尽量少的大段引用,注意自身文章的完整性。
三、写作之后
1.优化内容
从读者角度阅读,检查是否连贯,逻辑清晰,去重冗余。技术介绍类重介绍和实践,技术深入类重完整性及易读性,解决问题类重问题场景及解决步骤清晰度。
图文并茂、软硬件版本号
2.优化标题
简单准确,同一个系列使用相关格式列表
3.优化前言和总结
前言清晰有趣,总结简短完整
4.优化排版
突出重点关键字和次级标题
按照通用模板
附录:
1.技术介绍类模板
前言
目录
一、介绍
1. MVVM介绍
二、实战
三、更多
四、总结