为了账号安全,请及时绑定邮箱和手机立即绑定

如何写一篇技术文章,谈谈我的看法

标签:
Java

前言

只有光头才能变强。

有不少的小伙伴曾经问过我:

  • “3y你是怎么记笔记的阿?我一边看视频一边记笔记,顾头不顾腚的”

https://img1.sycdn.imooc.com//5df0f33b000168da06770360.jpg

下面来谈谈我一些观点(个人/主观),每个人都有自己的方法论,我的观点不适用于所有人。

开局一张图,内容全靠编:

https://img1.sycdn.imooc.com//5df0f33b0001a4cc10800575.jpg内容全靠编!

一、如何写一篇技术文章

按照我的思路,我可能会这样做:

  • 首先,这项技术是什么你得先告诉他。

  • 接着,为什么要学习这项技术,学习了这项技术有什么好处。有没有以前的技术跟这个较为相似的,为什么我不用以前的,而要学新的。(这一步非常非常重要

  • 然后,这项技术的核心用法是什么,给出一些小案例,让小白体验到这项技术。

  • 最后,用这项技术可能会出现什么问题,官方有没有提供方案解决,如果没有,可能的解决方案有哪些。

大白话来说,其实就是:

  • 是什么

  • 为什么

  • 怎么做

一般来说,我会把重点放在 为什么  ,因为我一直认为学习一门技术一定得知道:为什么要学

举个例子,我当初写【消息队列】的思路:

  • 回顾一下什么是队列,Java已经支持各种类型的队列了,跟消息队列有什么不同。

  • 为什么要用消息队列,不用行不行?用消息队列的好处有哪些

  • 用了消息队列可能会带来的问题

其实吧,我写文章都是按自己学习时的思路来写。如果我在学习时中途某个地方卡住了,我就认为可能在学习的时候也会存在同样的问题。所以,我就把我的理解给记录下来,如果有必要就画图来讲解。

二、文章需要有自己的风格

每个人写出来的文章都有自己的风格。

比如说有漫画型的:

https://img1.sycdn.imooc.com//5df0f33b000108f107210694.jpg

比如说有故事型的:

https://img1.sycdn.imooc.com//5df0f33c00012fda07190502.jpg故事型讲解

比如说有骚气型的:

https://img1.sycdn.imooc.com//5df0f33c0001bb8406430648.jpg骚气型

比如说有纯干货型的:

https://img1.sycdn.imooc.com//5df0f33d0001faf706950733.jpg纯干货

说了这么多,其实我想说的是:写文章应该要带有属于自己的风格。而不是把网上的资料直接复制粘贴就完事了,这样没有感情,没有灵魂

三、关于排版

一篇好的技术文章,它的排版一般不会差。我认为写技术文章有几点可以提高一下阅读体验

  1. 整篇文章不要90%都是代码,适当减少代码,贴关键的部分就好了。

  2. 多分段,技术文章可能就相对枯燥,如果将技术的说明挤在一块,可能阅读起来没那么好的体验

  3. 增加图示说明 or 插入相关的图片

程序员写文章一般都用Markdown语法了,使用恰当的话,文章的排版自然也不会太差啦。所以还没用Markdown语法的同学可以赶紧用起来,这玩意特好学,从学到用起来就几分钟。

  • 我当时连简历都是Markdown语法…

https://img1.sycdn.imooc.com//5df0f33d0001fe7603000304.jpg

四、关于工具

无论是在Mac还是在Windows上都很好用。使用Markdown就肯定要考虑一个问题:图床用哪家

所以,从我个人的使用角度而言,并不会担心图床会挂问题。

https://img1.sycdn.imooc.com//5df0f4fd0001262d02500305.jpg


点击查看更多内容
TA 点赞

若觉得本文不错,就分享一下吧!

评论

作者其他优质文章

正在加载中
JAVA开发工程师
手记
粉丝
1.5万
获赞与收藏
6488

关注作者,订阅最新文章

阅读免费教程

  • 推荐
  • 评论
  • 收藏
  • 共同学习,写下你的评论
感谢您的支持,我会继续努力的~
扫码打赏,你说多少就多少
赞赏金额会直接到老师账户
支付方式
打开微信扫一扫,即可进行扫码打赏哦
今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与 放弃机会
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消