如何写好技术博客

文章目录

    • 1. 目的
    • 2. 实施方法
    • 3. 论文结构
      • 3.1 摘要写法
      • 3.2 背景写法
      • 3.3 正文写法
      • 3.4 结论写法
    • 4. 期望
    • 5.参考文献

1. 目的

读书和工作以来,发现我存在一个问题:很多东西无法用自己的语言来描述,导致沟通容易出现问题。咨询了身边的一些同事和前辈,发现这个问题对于刚进入职场的职员而言很常见。主要原因有:1.知识点不到位,无法用简短语言描述;2.紧张大脑容易空白;3.对问题思考的太浅,看法单一;4.条理不清晰,叙述没有逻辑等等。如果是知识不够,可以通过多学习去扩展自己知识面,每个人都有自己专精和不足,不求任何时候都知道。容易紧张的源头有很多,但是通过多次练习可以或多或少的解决该问题。思考浅显或许是出于人的惰性,毕竟深度思考要花的时间和精力多很多。人没有实际经历或者刻意学习,很容易陷入和条理不清晰的误区。虽然前人对这点做过系统的思考,他们留下一些著作,教会人如何更好的表达,比如采用金字塔思维等。但是对于我个人而言,我需要自己去实验这些方法,来解决独属于我的问题“对于我而言,如何能将写技术博客成为一件游刃有余的事”。本文正是出于这个初衷所写。

2. 实施方法

为了能一直写好技术博客,先需要了解什么是好的文章。
我以为一篇好的文章,它应该满足:
1. 目的明确,全文应该有个主要要解决的问题,文章围绕该中心展开;
2. 结构清晰,技术类型的文章一般采用总分总等结构,开头提出论点,中间有序论证,结尾总括论点(可略);
3. 条理清晰,文章中的论证结构完整,论证中的理由和结论密切相关,且能支撑结论,并且若论证存在假设,最好在给出理由前说明假设;
4. 纯粹观点较少,文章中给出的证据或理由不和观点混淆,不以个人观点替代更有效的证据;
5. 通俗易懂,作者多用意义明确的词,对容易出现歧义的关键词有所提示。

既然知道如何评论一篇文章,那接下来就是在书写时应该时刻记着这些标准,根据达成情况努力修改论述,相信能有所收获。
最后也最重要的是,通过刻意练习,形成书写习惯。

刻意练习:
1. 有定义明确的特定目标 — 提升写技术博客的技能
2. 刻意练习是专注的 — 尽量在一段连续的时间内书写,并且在这时间只专注做这一件事
3. 刻意练习包含反馈 — 写完给自己以及很多人看
4. 刻意练习需要走出舒适区 — 多写多练
5. 需要优劣分明的评价标准 — 博客应满足上述标准
6. 刻意练习需要行之有效的方法 — 按固定的模板熟悉如何写博客

3. 论文结构

良好的结构不仅利于阅读,还利于写作,就如任何一篇文章若先有摘要,读者能判断是否是他所要读的,作者能判断是否有写的必要。一篇论文应该有其主题思想,技术博客同样如此。而为介绍这个主题,学术论文的结构是先介绍其背景,再介绍主题内容,最后进行总结。技术博客若同样如此,则更符合读者的习惯,因此技术博客最好能包括摘要、背景、正文和结论四部分。

3.1 摘要写法

摘要的目的是让读者发现这里是否有他关心的东西,并确认他是否需要读该文章。

主要包括对研究目的、研究方法、研究结果和结论的简要描述。

3.2 背景写法

目的是对博客的主题有一个直观的了解。知道它是从何而来,又为何成为一个问题或可以讨论的东西
主要包括:
    理由:为何写该文章,如果是技术分享,可以省略
    详情:文章要介绍的是什么领域的什么问题
    已有工作:在本文前已达到什么地步,有什么不足
    预期:研究之后能获得的东西

3.3 正文写法

目的是详细介绍对主题的论证
详细介绍论点论据,可以按时间、大小、逻辑顺序进行论点的介绍

3.4 结论写法

目的是对前面的论证进行总结升华
主要描述对主题的论证结果,和该结果带来的影响,以及TODO

4. 期望

希望我能坚持把Blog坚持到底。并且能有一个非常高的质量。
勇敢迈出第一步

5.参考文献

  1. 技术文章的写作技巧
  2. 《刻意练习:如何从新手到大师》安德斯·艾利克森(Anders Ericsson)、罗伯特·普尔(Robert Pool)

你可能感兴趣的:(个人成长,学习方法)