前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >如何写出一篇登得上大雅之堂的技术博客

如何写出一篇登得上大雅之堂的技术博客

作者头像
用户2802329
发布2018-08-07 15:23:51
4010
发布2018-08-07 15:23:51
举报
文章被收录于专栏:Android先生Android先生
作者:代码咖啡

地址:http://www.jianshu.com/p/edee8c40e5d7

声明:本文是代码咖啡原创,已获其授权发布,未经原作者允许请勿转载

写在前面

本文原标题为:【Mac流派】程序猿修炼之道(7)-技能篇之如何写出一篇登得上大雅之堂的技术博客,后因标题如古时女人的裹脚布——又臭又长,遂改为:如何写出一篇登得上大雅之堂的技术博客

我叫程序猿,于公元2013年9月1日被一股洪荒之力推入一个名叫挨踢圈的巨坑,从此开始了我的程序猿修炼之道。从买装备到学习程序猿的小习惯,再到学习Markdown、git指令,各位猿猿们一直在学习,我们知道知识的多元化在于共享,共享的途径有很多,而写博客就是其中一种。如果你是刚入简书的新猿类,是否对写博客不知如何下手;或许即使写好了一篇博客,但是感觉相比于专题中看到的他人博客相差甚远?今天,我们来聊聊如何写出一篇能登上大雅之堂的技术博客,为我们Level 7的进阶做铺垫。

我为什么要写博客?

写博客之前,一定要在心里好好地问自己:我为什么要写博客?我记得自己初入简书是受学长“李响同學”引导,因其奇佳的段子手天赋引来了诸多粉丝,尤其是《李响同學 #你的包里有什么》一文,让我感觉此文将其个性展现的淋漓尽致,一时兴起,注册了简书账号,期待着自己有一天也可以像他一样,但是时间一天天的过去,我开始陷入沉思:总不能什么事都不做,坐等粉丝呼呼地来关注我吧!于是我绞尽脑汁,掏出我的“满腹经纶”,终于憋出了《闲谈码农群体的新鸟和老菜鸟》这篇文章,但是总感觉缺了点什么,觉得自己只是为了写文章而写文章,无法将自己心里的东西挖掘出来。在后来两年多的时间里,一路跌跌撞撞将博客写下来,渐渐地找到了答案。写博客,尤其是写技术性的博客,请记住一点:我不是为了在我的文章数量上+1而写博客!

写博客的目的应该是:我在开发过程中遇到了一个问题让我困惑了很久,我查询了网上的资料,结果千篇一律,都没有解决我的问题,最终我通过询问他人、阅读源码、在他人的基础上对问题有了更进了一步的理解,我想把解决方法和他人分享,以免他人遇到相同的问题,继续踩坑,重复制造轮子,所以我要写博客。

写博客前我要准备什么?

明确了写博客的目的后,我们要开始着手准备用来充实博客内容的素材:

  • 图可以包括:效果图、思维导图、示意图 等,若更深一步,可以加入软件工程里的用例图、UML图、静态图、包图、甘特图 等。注意在需要着重讲解或不容易用语言描述的地方一定要加入有意义的图,用以辅助说明。
  • 代码 代码可分为完整代码和代码片段。完整代码不宜放入文章内容中,应上传代码仓库,并在文章末尾添加代码仓库链接,方便读者访问;代码片段放入文中, 作具体讲解,片段代码可以像下面一样添加: public class Code { // 这里是填写代码的地方,用代码框框起来 }
  • 解决思路 解决思路是问题从被发现到寻找答案再到被解决的中心思想,是笔者与读者交流解决问题的心路历程的核心,推荐以线性思维贯穿整篇博客。

文章内容如何排版?

正式进入写文章阶段,按照问题的解决思路,相信每一位做好充分准备的笔者都能将文章写得很充实,但是充实并不代表能让读者赏心悦目。人靠衣装,文章也要靠排版给读者带来良好的用户体验。简书对于文本编辑提供了两种编辑器:富文本Markdown 。这里我是比较推荐使用Markdown的,方便排版,便于引导笔者将注意力更多地放在文本内容编辑上而非对文本样式的控制,接下来讲讲内容该如何排版,排版可从以下几点进行深化:

1、文字 文字大小、字体需统一,对于需要强调的内容可用粗体斜体 来突出,但是不推荐全文大篇幅的粗体斜体,这样会让文章看起来不整洁,不够大气。

2、标题 简书的标题和文章内容是分开的,所以这里的标题是段落的小标题,而非文章主标题。段落的标题需要显眼,让人一目了然,对标题的处理常见的方式为:

  • 加粗、加大字体
  • 使用引用,为标题整行添加背景

3、段落

段落是一个中心思想的集合,段落之间建议空一行,让文章看起来层次分明;一个小结结束后,段落之间可以添加分割线进行小结的划分,但是极不推荐每个段落都用分割线分割,这样会让文章看起来档次很低,有一种随意做笔记,登不上台面的感觉。

4、代码 文章中嵌入代码方便读者更好地对问题的解决进行理解。象征性的代码推荐使用截图实现,象征性的代码一般非解决问题过程中直接用到的代码,而是类似于源码,用来说明问题的辅助性代码,如下图:

而关键代码推荐在代码框手动输入,这样方便读者对代码进行粘贴复制,同时使用代码框也可以将代码和原文很好地划分开,方便读者阅读。

5、图片 图片作为辅助性素材,可以恰到好处地弥补语言不以描述的不足,一般放在描述性文本内容的前面,图片下方亦可添加图片的简单说明,效果更佳。简书图片使用七牛云处理,修改图片链接后的参数,可对图片的大小进行调整,推荐写博客时适当调整图片大小达到布局排版平衡,参数修改如下图,w表示宽度,后面选中的数值表示宽度的像素点:

6、转载 作为对原创最基本的尊重,转载时务必在文章底部或文章开头添加原创文章的链接;为方便读者对问题更加全面的理解,建议笔者在文章中添加自己解决问题时参考的文章链接。

写好博客后做什么?

写好一篇博客后,不要急着发布投稿,先做好以下几点:

检查文章错别字

润色文章语句,使读起来连贯通顺

检查代码格式和字母拼写是否正确

检查链接是否有效

做好以上几点,接下来可以考虑发表并投稿文章,投稿文章时请注意以下两点:

  • 投稿时间 关注简书的用户大多是在校大学生和在职上班族,他们一天大多数时间都投入上班学习中,唯有在早餐时间午休时间晚上下班后到临睡前 这些时间段是有空浏览简书的,所以建议在这几个时间段投稿自己的文章,而且这些时间段里,文章被收录的处理时间更短,浏览量会更高。
  • 投稿专题 好马需要有伯乐的赏识,一篇好的文章需要有好的专题环境才能获得更大的关注度。选择专题需要关注专题收录的文章类型订阅人数,合适的文章类型能快速的让读者找到自己文章,而订阅量大的专题可以极大地提高文章的点击量。

写在最后

在浏览简书的时候,我经常可以看到有这么几类文章浏览量和点赞人数非常得多:鸡汤励志文工具推荐文速成效率文高逼格不知所云但云之有理文 。在这里强调一下,我们写技术博客的主要目的是分享自己解决问题的经验,其次是通过写博客来温故或者说是更深一步地理解问题的本质。不论我们写什么文章,重要的是通过 来给自己带来实质性的价值,所以希望大家不要盲目追求点赞量,失去自己写博客的初衷。不忘初心,方得始终!

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2017-09-21,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Android先生 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档