关于程序员:干货如何写一篇还算凑活的博客文章

前言

🍊原因

所有源于酷爱

说进去本人都打动了，差点就信了。真正起因是 加入了【掘金】的启航打算 ，流动期间有 三篇文章被举荐到首页 即可取得奖品。本狗秉承瞎猫碰到死耗子的信心，最终如愿蹭了一波福利。自此有些自豪收缩，特来写一篇文章压压惊，以本狗 理论写作流程 为例，分享一下本人的 写作套路与心得 ，更心愿能以此 激发宽广博友的写作激情。

🎯次要指标

实现 5 大重点

1. 如何构思一篇 成型的文章
2. 把握博客文章 写作的个别流程
3. 如何 丑化 或调优文章格局
4. 理解写作博客 罕用的辅助工具
5. 把握 各大博客平台的公布限度

🍩水图

秀一波实体奖品

掘金编织袋 + click 午睡枕 + 稀土掘金 who cares 系列咖啡杯 + 优质创作证书实体证书

🍯猜你喜爱

文章举荐

【事变】记一次意外把公司我的项目放到 GitHub 并被 fork，如何应用 DMCA 下架政策保障隐衷
【我的项目实战】SpringBoot+uniapp+uview2 打造一个企业黑红名单吐槽小程序
【ChatGPT】手摸手，带你玩转 ChatGPT
【ChatGPT】SpringBoot+uniapp+uview2 对接 OpenAI，带你开发玩转 ChatGPT
【模块分层】还不会 SpringBoot 我的项目模块分层？来这手把手教你！

注释

🏀写作前置问题

为什么写？在哪写？怎么写？ 通过三个问题进行分析

1️⃣. 为什么要写博客？

鉴于本狗多年教训剖析，大抵分为以下几种状况

1. 常识积攒，自我总结型 🤣

通过 自我反思 ， 自我总结 ，将本人开发过程中遇到的问题进行 收集整理，记录以作后用

2. 技术大佬，炫技分享型 😬

像各大博客论坛中的 博客之星 ，开发教训的 积淀积攒 ， 大厂履历 的工作剖析。将本人的教训及履历总结，分享以 领导后辈

3. 技术引流，广告推广型 🤤

通过技术博客进行 流量引入 ，应用付费文章或者广告模式植入，在分享的同时，尽可能的 引流变现。

2️⃣. 把博客写在哪里？

1. 本地存储

✅长处：写作灵便，无敏感词限度
❌毛病：分享形式繁多，容易失落

2. 支流技术博客平台

✅长处：分享灵便，SEO 优化好
❌毛病：敏感词限度，平台有各自举荐算法，需保障继续更新

3. 集体博客网站

✅长处：分享灵便，无敏感词限度，有本人的招牌
❌毛病：SEO 优化及数据分析需本人解决

3️⃣. 怎么写博客?

1. 梳理常识架构

整顿技术内容 ，如写一篇 SpringBoot 技术文章，则须要 梳理知识点，让看文章的人或者本人通读起来顺畅，让读者有一个大抵的思维概念

2. 抉择展示模式

写作特点因人而异，有的是 滑稽漫画写作模式 ，有的是 科技感文字配图 ，有的是 搞笑搞怪的谐音梗 。抉择因人而异， 表白本意 ，能 吸引读者即可

3. 突出重点指标

表明指标或重点内容，让读者有侧重点

4. 组织表白语句

一百个人有一百个哈姆雷特 ，须要将本人 理解消化的知识点 转化成 通俗易懂的大白话，正当输入

5. 总结演绎整顿

长于总结演绎，将整篇内容揉碎，筛除精髓

💥大佬们别着急划走，磨刀不误砍柴工，上面才是 重点！！！

🍄具体实操

梳理完后面问题之后，咱们心里就有了大抵的草图，以步骤下为 本狗理论写作流程，可抉择参考

1.【前言】大模块

前言模块总览

【原因】

介绍写作原因，一个 开篇引入 ， 长篇累牍 ， 滑稽形容即可

【浏览时长】

本文 浏览时长预估 ，能够依据 文章字数 预计出大略 浏览工夫，让读者通过工夫有个文章长短概念

【前置条件】

有些文章解说可能须要 前置条件 ，如介绍 SpringBoot+uniapp 实操我的项目，前提必须告知用户须要筹备如 IDEA/HBuilderX 等开发工具， 揭示读者做好筹备

【次要指标】

指标前置，将本文次要指标着重标识

【水图】

再粗疏的文字也不如图片吸引人，没图还说个 JB 啊，图片加文字更有代入感

其余可依据集体爱好，梳理明确即可，如下是本狗的一篇 markdown 的文章，供大家参考，【Apifox Helper】主动生成接口文档，IDEA+Apifox 懒人必备

![图片转存失败，倡议将图片保留下来间接上传
## 前言
### 🍊原因
#### 接口文档对接爽，整顿起来真费脑
对于 ** 整顿 API 文档 **，本狗秉承偷懒为上的准则，想找一种 ** 在 IDEA 中间接生成文档 ** 的办法。**Apifox Helper** 绝绝子，只须要在 **IDEA 中下载插件 **，无脑配置后，** 文档主动生成到 Apifox**，美完满解决。并且 ** 颜值及不便水平 ** 绝比 Swagger 和 postman 好太多。### ⏲️本文浏览时长
#### 约 10 分钟

### 🥮前置条件

 #### 1. IDEA 开发工具
 #### 2. Apifox(不必要)

### 🎯次要指标
#### 一秒生成接口文档

### 🍩水图
#### IDEA 中我的项目接结构图
 (https://img-blog.csdnimg.cn/f161ce9cb37b4a2bbba109329c444020.png)

想理解上图模块分层办法的同学，能够参考[《还不会 SpringBoot 我的项目模块分层？来这手把手教你》](https://blog.csdn.net/baidu_25986059/article/details/128739849)
#### 生成到 Apifox 接口文档图
 (https://img-blog.csdnimg.cn/1684e21db4784cdab5bfe0164ea9d8a8.png)
### 👨‍🎓试用人群    
#### 1. 像本狗一样【偷懒】不违心整顿接口文档
#### 2. 学习新鲜文档生成及治理形式
******
]()``
#### 2.【注释】大模块
此模块解说此文章的重点，依据理论状况进行正当步骤拆分，引领读者思维并进，按需解说所论述内容

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/040e996bd20a4197b75ede51c48c4166~tplv-k3u1fbpfcp-zoom-1.image)

如本狗的 Apifox Helper 插件内容介绍，简略分为 4 步，通过如何装置，再到如何配置，最初实操测试，展现最终后果。此模块因人因我的项目而异，语句通顺通俗易懂解析即可。如下是本狗的一篇 markdown 的文章，供大家参考，[【Apifox Helper】主动生成接口文档，IDEA+Apifox 懒人必备](https://blog.csdn.net/baidu_25986059/article/details/128991855?spm=1001.2014.3001.5502)

![图片转存失败，倡议将图片保留下来间接上传
##  注释

####  🐋1. 在 IDEA 装置【Apifox Helper】插件
> 点击 File=>Settings，找到 Plugins, 输出 **Apifox Helper**，点击装置，而后期待胜利后 ** 重启 IDEA**, 肯定重启才会失效！！！(https://img-blog.csdnimg.cn/f8d2867dc3c34f41885bbb97ff5f0316.png)
 (https://img-blog.csdnimg.cn/e3abc38bba54422b9cbcadcb765d0640.png)
 
> 🎯Tips: 你能够抉择 ** 同步到 Apifox 我的项目中，也能够间接导出 markdown 文档 **。如果是同步到 Apifox 我的项目，你还须要下载或注册 [Apifox 软件](https://www.apifox.cn/)，并查看上面【Apifox Helper】的配置规定。如果不须要则只须要在我的项目中找到须要生成文档的 Controller，右键后 Export Markdown, 间接导出 **apifox-api.md** 到对应目录。(https://img-blog.csdnimg.cn/bb4669b70f3e47959f9c37653d96353b.png)
> 关上 apifox-api.md 文件查看

 (https://img-blog.csdnimg.cn/d33fc72f73b14d5bab1a674687497607.png)
******

####   🦢2. 批改【Apifox Helper】对应配置
> 点击 File=>Settings=>Other Settings，找到 **ApifoxHelper**

 (https://img-blog.csdnimg.cn/c2dca06f772e479a8df5f3216c6ea84c.png)


 ##### 1. Apifox 服务器地址
 > https://api.apifox.cn


 ##### 2. API 拜访令牌
> 关上 Apifox 软件，点击左侧【头像】，点击【账号设置】，找到 API 拜访令牌

 (https://img-blog.csdnimg.cn/0348be242df84f46836a7eedc21ce61a.png)
 (https://img-blog.csdnimg.cn/7bc3c602e7fd4db2a75fe45b48ececb4.png)

******
> 点击新建令牌，填写名称及有效期，本狗填写名称为【IDEA 专用】，有效期为【无限期】，点击【保留并生成令牌】(https://img-blog.csdnimg.cn/75da0c17f3b94efeb19244898b020935.png)
******
> 复制令牌到 IDEA 中【Apifox Helper】配置项的 API 拜访令牌

 (https://img-blog.csdnimg.cn/68bb8b9a2d7a4791b19cd2c809c83a46.png)
 (https://img-blog.csdnimg.cn/45fd961194d94d64878dba07f59424e3.png)

 ##### 3. 模块我的项目 ID 配置
> 关上 Apifox 软件，新建我的项目，本狗我的项目名为【bkb】, 并确认

 (https://img-blog.csdnimg.cn/69f38d4fc5404158b73dae4690cf3eb6.png)
 (https://img-blog.csdnimg.cn/5df6fb0cd85c4c709287de0a26d5cd22.png)
******

> 进入我的项目【bkb】，点击【我的项目设置】，点击【根本设置】，复制我的项目 ID
 
 (https://img-blog.csdnimg.cn/bedbea655f274cbabbac12877bbb4a8b.png)
 (https://img-blog.csdnimg.cn/08dfddc7f50b4fdea123de2b33b0813c.png)
******
> 将上述复制的【ProjectID】到 IDEA 中【Apifox Helper】配置【模块我的项目 ID 配置】，我的 ModuleName 为【bkb-boot-controller】，所以构造是 bkb-boot-controller:xxxxx, 点击【OK】(https://img-blog.csdnimg.cn/8ee2a423016f4d1299eb10145116655f.png)
 (https://img-blog.csdnimg.cn/730173da7d8140f5949de7c3c3a5d531.png)
******
####   🌈3. 生成文档

> 右击【bkb-boot-controller】模块，点击【Upload to Apifox】，期待实现即可

 (https://img-blog.csdnimg.cn/1445c8c6fe234a828f6bcb70bcafa924.png)
 (https://img-blog.csdnimg.cn/2822decc74914d8eb259de222a829424.png)
******
####   🍎4. 查看 Apifox 中主动生成的文档
> 肯定要点击下 Apifox 软件右上角的刷新！> 肯定要点击下 Apifox 软件右上角的刷新！> 肯定要点击下 Apifox 软件右上角的刷新！(https://img-blog.csdnimg.cn/544a895448ec46f98b950cb6707ecea6.png)
> 查看成绩，功败垂成，之后便可随心所欲了

 (https://img-blog.csdnimg.cn/303a77d57f0f493a92c39acf48efba2d.png)
******
]()

3.【总结】大模块

此模块以概括为主，总览全文，总结为主。如下是本狗的一篇 markdown 的文章，供大家参考，【SpringBoot】还不会 SpringBoot 我的项目模块分层？来这手把手教你

🧰辅助工具

1.emoji 罕用图标库

https://funletu.com/emoji/

文章中有很多中央应用了emoji 图标表情，此网站复制即用

2.Markdown 排版利器

http://md.aclickall.com/

通过此工具可将枯燥的 markdown 文件丑化，转变成对应精美的 HTML 页面，模板款式可选，并反对代码自定义

3. 封面图取材网站

https://www.pexels.com/zh-cn

通过此工具可选取封面图，最终重要的是收费且图片科技感十足

🍅支流博客平台

分享一下本狗平时公布的博客平台

1.csdn

https://blog.csdn.net/

2. 稀土掘金

https://juejin.cn/

3. 博客园

https://www.cnblogs.com/

4.51CTO

https://home.51cto.com/

5.segmentfault 思否

https://segmentfault.com/

总结

本文通过 程序员角度登程 ，介绍了写作博客的 整体思路及流程。以本狗理论写作为根底，向大家介绍了个别写作的套路。以上步骤仅是自己的一点高见，心愿能给大家一点帮忙。