如何写一篇好的技术博客

如何写一篇技术博客 谈谈我的看法 一、如何写一篇技术博客 首先,我认为要把自己当做是一个分享者,而读者是一个小白。然后模拟这个场景:如果你要把你学习到的技术分享给小白,你需要怎么去做。 按照我的思路,我可能会这样做: 首先,这项技术是什么你得先告诉他。 接着,为什么要学习这项技术,学习了这项技术有什么好处。有没有以前的技术跟这个较为相似的,为什么我不用以前的,而要学新的。(这一步非常非常重要) 然后,这项技术的核心... 阅读详情

  在工作过程中,发现对很多东西都一知半解,不是很透彻,到头来很容易模糊。如果有一篇好的技术博客予以总结,一来即使忘记了,回过头来再看,仍然能够从自己的思路中恢复;二来总结一下,还会发现一些潜在问题;三来,有利于大家交流技术。很多大公司都有自己的内部技术博客平台,写好自己的技术博客,对一个技术人员来说,也有一定的成就感。

  在网上查阅资料,经常可以看到一些技术博客,要么废话连篇、排版紊乱,要么代码占了篇幅的60%,有些甚至是错的,会让人产生误解。因此,在这总结一下一篇好的技术博客应该是怎样的,同时也规整自己的不良习惯。本篇博客纯属个人的一点想法,是个原则性的东西,切忌逐条对号入座啊。

  本篇博客耗时2小时。

  一、带着明确的目的写博客

  经常看到这种博客,为了写博客而写博客。比如一篇介绍socket接口的使用方法的博客,罗列了一堆代码,凑上几句话:“首先...,其次....,最后...”,就算OK。如果你的目的是“练习如何使用写博客的软件”,或者“罗列接口”,甚至“练习写作的方法”,那么可能达到了目的。但是我想,写一篇技术博客,首先是要明确该博客的目的,通常是学习一项技术、解决一个技术问题什么的,比如“学习Linux内存管理机制”,“解决kernel pannic的问题”,“打发时间”等。

  不是所有的的事情都要写一篇博客来记录,要有自己的判断什么东西值的写,什么东西不值的写。

  二、写自己的博客

  网上相互转载的帖子很多,一篇写的不错的博客经常会被转载,建议不要轻易转载别人的帖子,要写自己的博客。同样一个知识点,或者同样一个问题,你的理解和别人的理解的程度很可能是不一样的,如果轻易的看过以后转载了别人的博客,可能意味着一次自我学习或体会的机会的放弃。可能有人会说:”同样一个GFS的架构图,我画也是这样,他画也是这样,因为GFS就是这样设计的“,这里并不是要求任何一个细节都自己去做,而是要有自己的想法、自己的理解,比如GFS分层的原则是什么?为什么这样分层,分层的好出?如果我要是去做的话,我会怎么搞?

  写自己的博客可不是意味着不转载别人的,比如说我看了一篇博客,并且经过实验,却是与博客里面写的完全一致,不多也不少,如果要是自己的写的话,也会写的基本一样,那就没必要再花费时间自己写了。另外,以及纯粹记录性的博客,可以转载,比如“C语言运算符的优先级”,当然转载还是原创都不重要了。

  另外,把别人的好的博客作为自己的原创,不但没品,而且自欺欺人。

  如果在博客中参考了别人的博客,可以在参考资料里面提及,如果是完全转载,也应注明转载出处。

  三、博客是总结,不是过程

  写博客有的时候是一个解决问题的过程。为了解决一个问题,今天采用了a方法,发现不行,明天采用了b方法,发现也不行,后天采用c方法,发现行了,那么最终的博客应该是在c方法解决问题后,开始写的。当然,前面的a,b方法,是需要做记录的,但只是博客的原始材料,而不是博客本身。

  在刚开始写博客时,我经常出现这种情况:对一个技术不清楚,想了解一下,就开一篇技术博客,边查资料边填写博客,结果基本上就是读、复制、粘贴、读、复制、粘贴...的过程。最后落到自己手里也是空空如也,想起一句谚语:“狗熊掰梆子——掰一个丢一个”,在懊恼自己的缓存为什么这么少的同时,我也想是否是方法不对?后来我想过,要想掌握一项技术、知识,大概需要这样一个过程:实践遇到问题——理论学习问题——实践解决问题——理论总结问题。我想很多情况我是缺少了其中的三个部分,只有“理论学习问题”的过程。

  后来,我就改成按下列步骤写博客了:

  • 碰到了问题,如果解决不了,而又比较有价值的话,就先记录下来,作为一篇博客的开篇。
  • 首先,先自己分析问题,基于已有的现象,思考,在笔记本上记录问题与可能的思路。
  • 其次,从外界获取经验或者知识,比如请教别人,google等,学习他们,在笔记本上记录关键点。
  • 然后,在实际中用学来的方法去解决问题,笔记本做好记录,要像水流过水渠一样流淌前面记录的思路。
  • 最后,拿过笔记本,将以上过程再总结成一篇博客。

  当然,并不是所有博客都能够先从"实践遇到问题"开始,因为很多情况下都是先从书本理论开始学习的(这也就产生了一定的局限性,有时候你学的很好,反而陷入了固有的框架;有时你学的不好,显得自己更加无知)。这种情况,问题是需要自己总结出来的,比如ULK上会介绍中断和异常的处理机制,这包括中断的过程、CPU的工作、内核的工作、软中断的处理、tasklet等等,我们学习中断,不仅仅是一旦发生中断,Linux内核是按照什么流程去处理,而是要找到这么处理的原因,也就是解决了什么问题。有时,实践验证的成本过高,在有条件的前提下做吧。

  知识开始学习的时候,经常是只见树木,不见森林。俗话说:”孤木不成林“,弄上三五棵树,才会有”森林“的感觉。        

  四、尽量拒绝三手技术

  在实际学习或者工作中,一个问题不明白,那么就需要请教别人。如果能够从周围的高手、牛人那得到简单、直接的答复,那是最好的。如果不能,就需要自己在网上查找资料,可能一个问题,林林总总的在网上能搜出很多,选择看哪些就是个问题。尽量去选择原发性的材料,如果你在查gcc的一个编译选项是什么意思,可以使用man手册,如果还不清楚,就去gnu的官方站点去查,最好不要随便从某个转载的技术博客上获取。如果你要找x86平台CPU访问内存的方式,应该从Intel的官方站点去找CPU的资料,最好不要随便在网上找篇博客看了拉到(起码应该先看官方材料)。

  别人的博客自然带有别人的理解,而这种理解可能带有一定的主观性,有时甚至是错误的,应该养成从原产地采购的习惯。如果哪天能够发明一项技术,那么这算一手技术;如果你在学习一项成熟的技术,那么该技术就属于二手技术了,如果你再从一个非源发性的地方去学习,那么很可能就是“三手技术”。当然,需要考虑实践成本,有时实在找不到源发性的材料,也不要太勉强自己了。另外,英文文章的水平整体高于国人的文章水平,应该尽量看英文文章。

  五、分清主次、落脚关键点

  世界万事万物都有联系,凡是和本篇博客的主题有联系的问题,都在本篇博客中描述,是不现实的,也是没必要的。个人认为,一篇技术博客应该不超过两个主题,如果超过了,就应该拆分。但是次要问题可能会有不少,这些次要问题不一定都要解决掉,但一定要分清除优先级,和主题关系比较大的,应首先解决,关系小的,应其次解决,甚至并不在本篇博客中解决。对于没有解决的问题,可以列在”遗留问题“中,对于在其他博客中讨论的问题,给予链接。

  根据自己的能力,耕耘到合适的层次。我将掌握一项技术划分为如下层次,在博客中通常应该达到第三个层次:

  • 听说过该技术,了解该技术解决什么问题;
  • 使用过该技术,熟悉该技术的使用方法;
  • 解构过该技术,熟悉该技术的架构、原理;
  • 贯通过该技术,将该技术与自己的以有知识完全融合,可以利用该技术架构或解决其他问题。

  六、技术博客的风格

  • 技术博客不是论文,技术博客由其实用性。当然,也有将论文发在博客上的,比如技术博客的作者大部分应该是工程师,而不是学院派。一篇技术博客可以是小到的一个编程技巧,可以写该技巧的原理、实现方法、好处,但不要写前500后300年的历史介绍和展望未来。技术博客通常关心技术的实用性,而非技术背后理论的复杂性。技术博客也不应该过分求全责备,把文章写的大而全,而应该追求小而精。
  • 技术博客应以陈述语气,个人感情色彩应该过滤掉,技术不是生活的全部。有人写技术博客,常喜欢加入自己的心情,“xxx让我好烦啊”、“xxx很难,我一直持续搞了两天没睡觉”,我个人拒绝这种“呻吟”的风格。
  • 忌罗列代码。代码是实现的过程,而不是原理,列代码是为了看清流程,而非为了列代码而列代码。我个人的习惯是尽量少列代码,如果能够使用校小的篇幅就能说明原理,绝不使用大篇幅的代码。但是如果简单的罗列代码能够一目了然,也绝不浪费过多的笔墨去描述过程。
  • 图片胜过文字。图片配文字比单纯的文字更加方便理解,甚至一张图就可以省略文字了,多画图,少写字是个原则。
  • 考虑时间成本。博客基本上是以时间换知识,因此需要越来越快,记录时间也很必要。
  • 列出时间遗留问题,以备以后解决。
E-Prime脑电实验打mark全攻略:从端口查询到串并口实战(附常见问题解决) 本文提供了E-Prime脑电实验打mark的完整实战指南,涵盖端口查询、并口与串口配置的核心步骤及常见问题解决。文章深入解析了mark原理,并详细介绍了通过E-Basic脚本和Serial设备对象发送信号的两种方法,帮助研究者实现E-Prime与脑电设备的高精度时间同步,确保实验数据可靠性。 阅读详情

相关推荐

五、2K0300 久久派开发板的GPIO控制与Shell脚本自动化实战

本文详细介绍了基于龙芯2K0300处理器的久久派开发板的GPIO控制方法,通过sysfs文件系统实现LED控制和传感器读取。重点讲解了Shell脚本自动化实战,包括LED闪烁、流水灯效果和传感器数据采集,为物联网项目开发提供完整解决方案。

silver的专栏 687

程序员怎样才能写出一篇好的博客或者技术文章?_如何写前端文章

这一类文章,往往是是偏向于技术科普,如《web3 是互联网的未来?》、《VR、AR、MR、XR 分不清楚》等。它们的共同特点是将新技术讲清楚,让读者对文章描述的技术内容有全面的了解,一般包含以下内容:1)新技术产生背景一个新技术往往不会凭空出现,一般伴随着一些历史进程的推进,如 WEB3 的出现并不是仅仅是资本的追捧,其诞生的目的是目标是无服务器去中心化的互联网,让用户自己掌握自己的身份数据。这里的技术背景可以从多角度来分析,业务发展述求、周边技术的更新迭代等都是其影响因素。2)与现有技术对比。

2401_84433974的博客 1748

BioEmu:微软黑科技炸场!生成式AI重构蛋白质模拟:千倍效率碾压传统计算,新药研发周期砍半

BioEmu 是微软推出的生成式深度学习系统,可在单个 GPU 上每小时生成数千种蛋白质结构样本,支持模拟动态变化、预测热力学性质,并显著降低计算成本。

士多啤梨先生の博客 1097

如何写好一篇技术博客

笔者:风起怨江南出处:https://blog.youkuaiyun.com/JackMengJin笔者原创,文章欢迎转载,如果喜欢请点赞+关注,感谢支持! 前言 一、写博客能给你带来什么? 二、优秀博客的特质? 三、写博客的选择方向? 四、如何写好博客的内容? 五、博客的未来? 如何写好一篇技术博客 前言 篮球论坛有篮球专业科普文章,比如对球员的技术分析,对比赛的战术讲解,对球队未来的展望; 汽车论坛有专业的汽车评测文章,化妆品也有专业的各类测评视频,就连做饭也同样是有详细的...

风起怨江南 2360

AMG8833红外测温实战:在STM32F103上做个简易人体感应与温度报警器

本文详细介绍了如何在STM32F103上使用AMG8833红外测温传感器构建人体感应与温度报警系统。通过硬件连接方案、驱动代码开发、人体检测算法实现及报警系统设计,展示了如何利用8x8红外温度矩阵实现智能监测功能。文章包含实用的初始化流程、温度数据读取优化和低功耗策略,为创客项目提供完整解决方案。

weixin_33725239的博客 393

服务器安装Ubuntu 18.04.2 LTS超详细步骤(小白图文详解)

服务器安装Ubuntu 18.04.2 LTS超详细步骤(小白图文详解) 本文不包括启动盘制作步骤,相关内容可自行百度 华为服务器 1 插入u盘,关机重启 2 初始化界面后进入到系统的BIOS设置界面 (华为服务器按Del键,不同品牌方法不同) 3 进入的时候,华为的服务器默认设置了BIOS密码,因此需要输入之前预设的密码。 注意密码大小写问题,若密码输错三次,则需重启 4 密码输入以后,进入...

crystalbang的博客 2万+

怎样写好一篇技术博客

为了验证 Redis Cluster 和哨兵模式的写入性能差异,我们搭建了同规格环境(8 核 16GB),使用 redis-benchmark 压测。结果显示:在 10 万并发下,Cluster 模式(3 主)写入 QPS 为 8.5 万,平均延迟 2.1ms;心里一凉:完了,促销活动刚上线就挂了…,既要让同行开发者看得懂、用得上,又要避免写成枯燥的文档或过于随意的闲谈。:《一次 Redis 大 Key 导致的服务雪崩:从 300ms 到 30s 的惊魂 10 分钟》:绿色(优)、黄色(中)、红色(差)

瘦到被风吹走的博客 844

适配adv7280m相机到rk3588的安卓平台

Kernel-5.10/arch/arm64/configs/firefly_defconfig里面增加配置CONFIG_VIDEO_ADV7180=y。出现一次开不了机器的情况,接调试口发现,在set_fmt里面用s_ctrl对mipi的频率进行设置会出现异常。设备树修改kernel-5.10/arch/arm64/boot/dts/rockchip/13.dts。把MEDIA_ENT_F_ATV_DECODER改回MEDIA_ENT_F_CAM_SENSOR。第二次编译,仅仅刷新boot.img。

chenyq14的专栏 2447

技术博客应该怎么写?

概述 首先,恭祝各位程序员(媛)们节日快乐!所以,今天咱不讲技术,我们说点别的。 作为一个程序员(媛),很多人都有写博客的习惯,我也不例外,而且已经有些年头了,所以在本文,结合我的一些经验来谈谈“技术博客应该怎么写?”这个话题。 目的 做一件事情总是有目的的,写博客也不例外,先来说说为什么写博客。 1. 记录问题 “只有再一再二没有再三再四”,这件事情在在程序员身上是不可能的,有些问题就像批了隐身衣一样,一而再再而三的,让我们在同一个问题上摔过很多次跤。怎么办呢,用博客记录下解决问题的思路、步骤、方法、出处

LZUGIS 1525

《QGIS快速入门与应用基础》239:指北针样式选择(预设/自定义)

系统解析指北针设计的核心规范与实操方法。文章首先强调行业规范红线,包括强制要求N字标注、箭头辨识度等关键要素,通过正误示例对比强化合规意识。其次详细讲解QGIS内置预设样式的分类应用,提供极简箭头、标准三角箭头等4类样式的选型对照表,并配图说明适用场景。最后介绍从基础微调到SVG导入的进阶自定义方法,帮助用户实现从合规到专业的样式设计。全文贯穿"合规优先、可读为本、美观为辅"原则,配有详细操作截图与规范对照表,适合从GIS新手到专业制图人员参考。

LuckyHanMo的博客 527

MuJoCo 入门教程(二)

本章介绍 MuJoCo 的数学和算法基础。对于熟悉广义或关节坐标建模和仿真的读者来说,整体框架是相当标准的。因此,我们将对这些材料进行简要总结。本章的大部分篇幅用于介绍我们如何处理接触和其他约束条件。这种方法是基于我们最近的研究,也是 MuJoCo 所独有的,因此我们花时间对其进行了详细的激励和解释。更多信息可参见下面的论文,尽管本章中的一些技术思想是新的,在其他地方还没有描述过。

机器人控制与仿真应用 3712

如何写出好的技术文章或做好分享

摘要:本文针对技术写作的四大难点(专业性强、主题枯燥、原理抽象、素材匮乏)提出解决方案。建议从七方面入手:1.充分准备技术素材;2.勇于实践行动;3.克服"知识诅咒",换位思考;4.主题升华;5.挖掘项目亮点;6.采用金字塔式逻辑框架;7.多使用架构图、时序图等可视化表达。强调技术写作需要长期积累,建议将个人品牌经营视为公司品牌打造,通过优质内容提升技术影响力。

langchao12的博客 1904

199、影像技术 roadmap 规划:未来移动影像的技术趋势与芯片算力展望

本文探讨了未来移动影像技术的发展趋势与芯片算力规划。作者从实际案例出发,指出影像技术演进需平衡传感器、ISP、算力和功耗。文章分为三部分:1)传感器将从堆像素转向提升信息密度,重点关注双层晶体管结构、混合快门和多光谱技术;2)ISP架构将向可编程计算单元转型,强调神经网络加速、硬件化多帧融合和语义处理;3)芯片算力瓶颈在于数据搬运,需优化存算一体架构、专用DMA和统一内存。最后给出五点建议:避免盲目追高像素、重视持续功耗、平衡ISP灵活性、预留算力余量、加强传感器与ISP协同设计。作者强调,影像技术的突破在

sundong_81的博客 57

我从大学开始写博客,如何写一篇技术博客,谈谈我的看法!

都知道写技术博客的好处,那怎么写呢?

3y 8721

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

华为的C语言编程规范.pdf

华为技术有限公司内部技术规范。本规范制定了编写C语言程序的基本原则、规则和建议。从代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面对C语言编程作出了具体指导。

如何用java写博客_如何写一篇技术博客,谈谈我的看法

前言我一直推崇学技术可以写技术博客去沉淀自己的知识,因为知识点实在是太多太多了,通过自己的博客可以帮助自己快速回顾自己学过的东西。我最开始的时候也是只记笔记,认为自己能看得懂就好。但如果想验证自己是不是懂了,可以写成技术博客。在写技术博客的过程中肯定会发现:“这个知识点,我好像还有些没搞懂”。从梳理/编写的过程,自己也会成长不少有不少的小伙伴曾经问过我:“3y你是怎么记笔记的阿?我一边看视频一边记...

weixin_36432451的博客 534

汉书HE8,好用的汇编代码编写工具

汉书HE8,好用的汇编代码编写工具早期编写汇编代码所用功能强大

上一篇: CUDA与C++的集成——学习笔记
下一篇: Win7建立并开启Wifi热点的bat批处理
hellowuhan
博客等级 码龄17年 10粉丝 1原创
评论 3
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值