写技术文的三个原则是什么?

2023-11-01

本文章原创首发于公众号:编程三分钟

我关注了很多技术类的公众号,看着大佬的公众号几千的阅读量,甚是羡慕,这直接导致了我没有心情减肥,甚至多吃了一个鸡腿。

要怎么才能写出一篇好技术文章,让读到的人感到身心舒畅,快速Get到想说的点,我想破了脑袋。

喜欢读我文章的人多少都和互联网行业沾边,像咱们这一行加班是常有的,看文章的时间也比较琐碎:蹲厕所、挤地铁、吃饭、睡前玩手机。基本就是这四个时间,不是正在做就是在去的路上,有木有?!

要在有限的几分钟里,让看的人能够流畅读完,并且掌握表达的点,是一个很有难度的事情。

我总结了一下,重点有三个:

  • 精简
  • 有趣
  • 成体系

精简

  • 精简,就是不说废话,珍惜读者的时间,把注意力集中在关键知识点上,最好在文章开始就能点明主题。
  • 绝不要大段的引用和铺概念,一旦出现这种情况,中间也没夹杂有趣的部分,很容易产生抵触情绪,这直接影响到阅读体验,像我这种爆脾气,要不是因为穷,直接就把手机摔地上了。

有趣

要让文章变得有趣起来,可读性强。

  • 发挥出全身上下的幽默细菌,适当写些段子无伤大雅,甚至可以加入一些故事情节,让人回味无穷。
  • 专业名词少用,说话越土越好越容易让人理解。别整天扯那些名词,又不是在写论文。
  • 有图千万别写字,有表格用表格,一张图胜过千言万语,当然了,能用动图就更棒了!

当然,有趣是建立在精简的基础上,又不是在写童话书,突出重点,把握好火候。

成体系

我看到很多大神技术水平很强,但是喜欢站在自己的角度上说技术,别人基本没办法看懂,写出来的文章也只能自己看。

在这里我特别想说,当我们在看一篇文章或一本书的时候,看个几行心里面产生一种情绪,“啊,太难了,我好菜啊!” 这不是我们的错,而是写文章的人的问题。

写技术文章不是写流水帐,要有脉络,从易到难,循序渐进,针对一个新概念要想清楚表达的方式。拆分难的知识点成小块,最后再联系起来。让人一下子看懂,成就感满满!我比较喜欢问自己:

  • what ? 我要讲的点是个什么东西?
  • why? 这个东东能做点什么,有什么用?
  • how? 要怎么做才能用上(实现)

最后

编程三分钟从4月27号开始到现在已经有整整五个月了,谢谢大家对小熊(我)的支持,风里雨里,我在等你。加油!

image.png

转载于:https://www.cnblogs.com/pzqu/p/11602657.html

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

写技术文的三个原则是什么? 的相关文章

  • Git技能树(3):Git使用

    Git技能树 3 Git使用 在开始 Git 的基础命令学习之前 我们先来认识一下版本库 Repository 接下来我们所有提到的 Git 基础命令 都是基于版本库的 那么什么是版本库呢 版本库又名仓库 英文名 repository 你可
  • mybatis-plus更新数据updateById返回false

    Packet byId ips getById 211l System out println byId Packet pa new Packet pa setId byId getId pa setStatus 1 pa setVersi
  • 霍夫投票直观理解

    霍夫投票法最典型的示例是二维图像中霍夫直线检测 过二维平面中的定点可以得到无数条直线 如果以顶点参数为做一条直线 即将这些直线变换到参数空间 那么这个定点对应参数空间中的一条直线 如果在参数空间中有两条直线相交于同一个点 那么说明对应的两个
  • Unity排行榜功能(使用MVC框架)

    要求 实现如图所示UI界面 按下某一按键实现排行榜的更新 M 数据模型类 主要负责数据 玩家的数据 public class RankModel 定义三个属性 姓名 分数 排名 定义构造函数 public string Name set g
  • 基于arduino下的巡线小车

    先发代码再进行解释吧 include
  • 《Head First HTML5 javascript》第10章 自定义对象

    2022 11 23 第10章 自定义对象 面向对象OOP Object Oriented Programming 对象是一个包含相关数据和方法的集合 通常由一些变量和函数组成 我们称之为对象里面的属性和方法 对象是存储在单个分组中的相关功
  • Git统计个人提交代码行数

    1 Git统计个人提交代码行数 git log format aN sort u while read name do echo en name t git log author name pretty tformat numstat aw
  • Windows系统文件快捷链接(软链接/硬链接/符号链接)mklink

    记录学习mklink 将大文件从c盘移出 快捷方式 软链接 硬链接 符号链接 快捷方式 常见文件链接方式 在Windows上以 lnk结尾的文件 这类文件通常用于指定某一个文件或某一个目录的位置 可扩展性很强 桌面快捷方式就是这类了 软链接
  • Ubuntu Openvino(YOLOV5)加载训练好的模型 xml onnx bin

    使用 Openvino 对自己训练好的模型yolov5 pt gt IR 进行推理 环境需求 Ubuntu 系统 20 04 vscode 编辑器 python3 Openvino 环境 priority 关键为 export 导出的修改
  • Libvirt简介

    Libvirt 是一个函数库 包含实现Linux虚拟化功能的linux API 提供了管理虚拟机的稳定的 统一的接口 其主要包括Libvirt API Libvirtd进程和virsh工具集三个部分 架构说明 用户程序 程序 virsh工具
  • Flutter基础(手势检测GestureDetector)-二

    import package flutter material dart void main runApp new MaterialApp title flutter质感设计 home new MyButton class MyButton
  • 核工业物理研究院九院三所

    1 流体物理研究所 一所 高能量密度流体力学过程 爆轰压缩 凝聚态 辐射流体力学等 可以说包括了核武器设计的基础理论部分和核试验 亚临界试验等的试验数据采集分析 2 核物理与化学研究所 二所 核物理 放射化学 核过程等 就是核反应堆技术 核
  • mongo 常用的命令

    一个mongod服务可以有建立多个数据库 每个数据库可以有多张表 这里的表名叫collection 每个collection可以存放多个文档 document 每个文档都以BSON binary json 的形式存放于硬盘中 因此可以存储比
  • 虚拟网络无法连接本机网络(Xshell无法连接虚拟机)

    Xshell无法连接虚拟机 类似于 Could not connect to 192 168 0 128 port 22 Connection failed 在很多博客中也看到过许多解决方法 例如 安装sshd的客户端 服务端 给sshd的
  • 华为mate30老是显示无法连接服务器,华为Mate30 Pro手机微信信息老是发不出,提示无法连接到网络...

    华为Mate30 Pro手机的微信信息老是发不出 并且在接收微信消息的有延迟 信号满格 时常提示无法连接到网络 微信时常半天发不出 发个东西转半天 接收也经常延迟几分钟才收到提醒 这是什么鬼手机啊 别人发来消息 一来就是好多条 还有十来分钟
  • priorityQueue优先级队列 (python、c++)

    优先级队列 优先级队列 python C 最近用优先队列写了一个SNIC超像素分割的工程 有兴趣的可以下载看看 VIP大佬让我赚一点下载积分吧 感激不尽 https download csdn net download koffee f 1
  • 2023天一永安杯部分wp

    web Query 布尔盲注 import requests import string dictionary string digits string ascii letters url http cd5a2660b462c867 nod
  • linux 开启curl命令,如何启用curl命令HTTP2支持

    当我们直接使用 curl 去请求一个 https 页面时 默认可以看到其默认返回的是 HTTP1 1 的 response 现在使用 HTTP2 的网站越来越多 技术也越来越成熟 如何启用 curl 命令 HTTP 2 支持就成为了一个问题
  • 洛谷 B2043 判断能否被 3,5,7 整除 题解

    这一道题很简单 首先 要输入一个数x 之后将判断x分别是否能整除3 5 7 为了进行依次的判断 我们要使用for循环 for int i 3 i lt 7 i 2 i 3表示从3开始循环 之后i lt 7循环到7结束 由于整除的数为3 5
  • 安装tensorflow过程中的报错

    安装tensorflow后 测试安装是否成功 结果报错 SystemError

随机推荐

  • 数组对象与字符串对象

    1 数组对象 1 1什么是数组对象 javaScrip中的数组对象可以使用new Array或字面量 来创建 在创建以后 就可以调用数组对象提供的一些方法来实现对数组额度操作了 数组对象用于在单个变量中存储多个值 JavaScript的数组
  • RocketMQ学习笔记 - 顺序消息

    文章目录 1 定义 2 代码示例 2 1 消息实体 2 2 生产者 2 3 消费者 2 3 测试结果 1 定义 顺序消息 FIFO 消息 是 MQ 提供的一种严格按照顺序进行发布和消费的消息类型 顺序消息由两个部分组成 顺序发布和顺序消费
  • PowerMockito单元测试(1)-主要思想以及常规异常覆盖

    1 测试主要操作步骤 要测试的方法 Component public class UserDao Autowired private UserMapper userMapper Autowired private SystemErrorRe
  • 【vue】v-viewer图片查看器的使用和通过函数直接打开图片预览

    引入v viewer依赖包 import Viewer from v viewer import viewerjs dist viewer css Vue use Viewer Viewer setDefaults Options zInd
  • 一份热力图可视化代码使用教程

    前言 特征图可视化与热力图可视化是论文中比较常用的两种可视化方法 上一篇文章 一份可视化特征图的代码 介绍了特征图可视化的代码 本篇将对如何进行热力图可视化做一个使用说明 本文介绍了CAM GradCAM的原理和缺陷 介绍了如何使用Grad
  • intellij idea设置等号对齐

    setting gt code style gt Groovy gt Wrapping and baces gt field groups gt align in columns 勾上 转载自http blog csdn net wulon
  • Ubuntu系统突然进不去系统,黑屏且左上角光标一直闪烁

    Ubuntu系统突然进不去系统 黑屏且左上角光标一直闪烁 环境描述 微星工控机 Ubuntu20 04 已安装显卡驱动 问题分析 前期使用一直挺正常 但是突然进不去系统界面 这类情况一般都是显卡驱动的问题 Ubuntu会不定期不知觉的升级内
  • windowManager向window添加、更新、删除view过程

    目录 一 window和windowManager关系 二 几个关键列表 二 add remove updata add过程 remove过程 update过程 三 Activity的window创建过程 一 window和windowMa
  • Shell基础— 变量定义的规则和分类

    1 定义变量的规则 在定义变量时 有一些规则需要遵守 变量名称可以由字母 数字和下划线组成 但是不能以数字开头 如果变量名是2name则是错误的 在Bash中 变量的默认类型都是字符串型 如果要进行数值运算 则必修指定变量类型为数值型 变量
  • 基于Qt的实时温度传输系统

    基于Qt的实时温度传输系统 引言 上位机设计 头文件 ui界面设计 初始化工作 串口功能设计 表格插入数据 保存表格数据 清空表格数据 开始绘图 暂停绘图 绘图设计 导出温度变化图 定时器 下位机设计 延时函数设计 串口设计 内部温度传感器
  • 【解决】openwrt编译错误automake错误255

    错误信息如下所示 Unescaped left brace in regex is illegal here in regex marked by lt HERE in m lt HERE t at home os openwrt sdk
  • 科学计数法

    链接 http www nowcoder com pat 6 problem 4050 题目描述 科学计数法是科学家用来表示很大或很小的数字的一种方便的方法 其满足正则表达式 1 9 0 9 E 0 9 即数字的整数部分只有1位 小数部分至
  • Mallox勒索病毒:最新变种malloxx袭击了您的计算机?

    导言 随着互联网的普及和数字化生活的发展 网络安全问题也逐渐成为了我们生活中不可忽视的一部分 其中 勒索病毒是一种恶意软件 它可以将您的数据文件加密 并要求您支付赎金以获取解密密钥 本文91数据恢复将介绍一种名为 malloxx的勒索病毒
  • [Unity&]PlayerPrefs.GetString的使用案例

    根据官方 案例PlayerPrefs SetString 进行测试 https docs unity3d com ScriptReference PlayerPrefs SetString html PlayerPrefs https do
  • 【华为OD机试c++】解压报文【2023 B卷

    题目描述 为了提升数据传输的效率 会对传输的报文进行压缩处理 输入一个压缩后的报文 请返回它解压后的原始报文 压缩规则 n str 表示方括号内部的 str 正好重复 n 次 注意 n 为正整数 0 lt n lt 100 str只包含小写
  • 猿创征文

    文章目录 1 KingbaseES是什么数据库 2 KingbaseES数据库产品优势 3 KingbaseES安装包下载地址 4 KingbaseES数据库安装 1 windows安装KingbaseES 1 图形化界面安装 2 命令行安
  • Java构造方法为private

    class A public String name 构造函数限定为private 不可以直接创建对象 private A 需要创建对象实例时 调用此函数 public static A Instance return new A clas
  • H.323协议分析

    感谢原作者 http blog csdn net bripengandre article details 2230087 整理记录 版本 时间 内容 整理人 V1 0 2008 03 28 H 323协议分析初稿 彭令鹏 H 323协议分
  • Vue 新手学习笔记:vue-element-admin 之入门开发

    说实话都是逼出来的 对于前端没干过ES6都不会的人 vue视频也就看了基础的一些 但没办法 接下来做微服务架构 前端就用 vue 这块你负责 说多了都是泪 脚手架框架布了都没看过 干就完事 不过好在做好了 这里写下给和我一样苦逼的同学能快点
  • 写技术文的三个原则是什么?

    本文章原创首发于公众号 编程三分钟 我关注了很多技术类的公众号 看着大佬的公众号几千的阅读量 甚是羡慕 这直接导致了我没有心情减肥 甚至多吃了一个鸡腿 要怎么才能写出一篇好技术文章 让读到的人感到身心舒畅 快速Get到想说的点 我想破了脑袋