小白向:写技术博客的好处和操作指南 | 青训营笔记

151 阅读3分钟

这是我参与「第四届青训营 」笔记创作活动的的第1天

前言

第一次写博客,在写博客之前,不知道博客的作用是什么,也没有撰文的思路

于是开始找资料学习怎么写博客

本篇博客适合和我一样不会写技术博客的小白

目录

写技术博客的好处&操作指南

好处

1.技术博客是面试的加分项

2.很好的备忘录,加深知识的理解,是一个复现加深巩固的过程

3.系统总结知识,知识体系化

操作指南

1.内容为主

2.写入门系列

备忘录、笔记、基础理解、踩坑记录

3.写实战类文章

环境搭建、操作记录、实战项目流程等

4.注意点

第一,坚持。第二,尊重知识产权,引用文章注明出处。

写文章的三个时段

一、写文章之前

1、明确目标

    i.  分享:提供快捷通道面向有同样需求的开发者
    ii.  复习:仅为了自己复习,不建议发文

2、明确类型

    i.  技术介绍型

        -   面向相关知识的技术小白

        -   基础知识

        -   实战demo

    ii.  技术深入型

        -   面向要进阶的开发人员

        -   从原理的角度深入分析某项技术

    iii.  解决问题型

        -   面向同样遇到此坑的开发者
        -   踩坑记录,写出解决流程

二、写文章之中

作为新手,可能很多时候明确了要写的内容,但是却不知道如何下手.....

1. 拟定标题

标题的要求有几个:

  • 标题不要太宽泛
  • 不要标题党,避免使用“最*”、“必须”、“震惊”等雷人的词

2.使用前言和目录

使用前言的目的是告诉读者本文的大致方向,让读者读完前言后就知道这篇文章适不适合自己

还可以使用思维导图或脑图制作一些目录

这样,文章的脉络就一目了然了

3.列个提纲

提纲写好了,就不至于文章写道一半写不下去了

比如介绍web前端:

  • web前端是做什么的?
  • web前端有哪些技术?
  • web前端的应用场景?

4.写作手法

常用的两种方法:

1、总分总

  • 开头():这个技术是一个什么样的技术,可以给我们带来什么?里面的主要功能是什么?
  • 介绍():这个技术每项功能如何使用。
  • 总结():这个技术使用的优缺点,在具体的实践中如何帮助我们。

2、在文章的开始阶段先抛出问题,让读者去思考,接着,从回答问题的角度,如何去解决问题

5.注意排版

可能文章的符合读者的需求,但是排版却不尽人意,导致读者没有读下去的欲望

可以参看阮一峰的:

《中文技术文档的写作规范》

三、写文章之后

  1. 从读者角度阅读文章

    • 把自己当做读者,判断文章是否 易读,脉络是否清晰
  2. 检查文章

    • 尽量避免错别字、病句和英文拼写等低级错误
  3. 美化文章

END! Thank you for reading

文章引用:

《为什么程序员必须写技术博客?》 B站UP:CodeSheep

《我是如何写好一篇技术博客的》掘金博主:九心