总结技术文章写作技巧
linshukai Lv2

1、端正心态

  对于写作不要产生恐惧,起点期望放低点,没有什么事情能一蹴而就,同时可以通过阅读其他的技术文章,模仿行文方式,不断重复练习,对比吸取相关长处,补足自己的缺点。

2、明确定位

 对于这篇文章需要给什么类型的读者看,需要怎样的技术背景,需要怎样的技术栈,以及相关的项目背景。明确了定位方便切入不同读者的阅读需求。

3、标题切入

  对于文章的标题需要提供给读者一个很好的切入角度,整篇文章围绕着标题,起到文章的中心作用。

4、简介与大纲

  针对不同的文章,如果对于一些小项目经验或者工具使用的分享,列提纲和简介能够给读者一目了然,在第一时间的情况下获取到需要的知识信息,简介中我一般喜欢写背景,即项目背景,或者技术背景,通过这些背景能够很好的把读者带到一个阅读环境。提纲的话就因人而异,如果仅仅是比较小型的分享,对于列提纲显得没那么重要。
  而针对大型的技术的分享,对于一些写到比较全的技术分享,就需要通过列提纲对自己的内容进行很好的归纳总结成每个点,同时提纲好处就是能够让读者随时从某个地方切入,省去一些自己知道的环节。

5、正文写作

  通过提问和问答模式:能够让读者目的明确地进行阅读,同时让读者带着问题去阅读,就能更好的抓住文章的重点和逻辑,同时读者的阅读效果和阅读感受就会更加好。
  通过讲故事的方法:讲故事的话,一般是可以设定某个情节,让读者代入到该场景,通过叙事的模式和节奏,让读者更加容易接受专业知识。

6、额外

  • 通过合适的段落和句子,减轻读者阅读的压力;
  • 对于需要结合代码讲清楚专业知识,则需要将代码贴出来,并且在一些关键的代码中需要有清晰的注释;
  • 对于文章出现的Demo可以附加上demo的链接;
  • 如果对于一些比较专业的术语或者细节,可以通过类比形式解释清楚问题,如果文字描述不清楚可以选择配图的方式;

总结

  • 取好标题,醒目突出中心
  • 图文并茂,适当配图说明
  • 篇幅适宜,不宜过短也避免冗长
  • 格式统一,基本排版规则需要遵守
  • 细节处理,错别字标点处理正确。

参考

参考文章:http://news.51cto.com/art/201904/594736.htm