写作对于技术人来说是最好的投资

上周日参加了腾讯云开发者社区和墨问西东组织的技术创作特训营活动,今天复盘一下。

虽说是技术创作特训营,现场到场的超过半数也都是技术人,但是分享的内容并不局限于技术人。

这次分享包括四个部分的内容,四个部分内容是一个体系,包括为什么要写作?怎么让读者能读进去?怎么锻炼提升写作能力?怎么写好技术文章?写作对职场有什么帮助?

我们来一一拆解。

一、怎么写出让读者能看进去的文章?

1、内容,言之有物

用最少的语言描述清楚一件事情,而不是最多。

要学会做减法,把自己想要表达的东西用最直接的方式写出来,删除所有不需要的东西。

2、格式,简洁美观

屏幕阅读和纸质书阅读差别很大,现在通用的做法:

1、首行不锁进;

2、中文和英文、数字之间增加一个空格;

3、段落之间多增加一个空行。

4、每一段话,不要超过 5 行。

3、言之有物

上一部分是门面,如果你排版不好,所有文字都挤在一起,那不管内容多好,都不会有人愿意读。

这一部分是建立在你排版 OK 的情况下,你的内容应该要有价值,要言之有物。

4、不要有知识性错误

知识性错误会导致读者对你的信任骤降,严重损害读者心中的形象。

5、用最少的字把事情说清楚,而不是最多

珍惜用户的时间,500 个字能说清楚的事情,不要写 1000 个字。

自己写完的东西要读三遍,做到至少没有语句不通顺、阅读不顺畅。

二、怎么锻炼自己的写作能力?

着眼当下,了解清楚,自己身边所有事情的来龙去脉。

举个例子:

你要写一篇长城游记。你可以去了解,为什么要建造长城?为什么要选择这个位置建造长城?建造长城有哪些成本?建好之后有什么作用?

三、怎么把技术文章写好?

1、能把别人教会,你才是真的懂

很多人不管是听课还是看书,都是看完、听完了事。自以为都懂了,但是你让他给你讲一遍,你发现他根本说不清楚。

甚至有些职场所谓的领导,为了在老板面前表现自己,领导说什么,都说自己明白了。但是,当你真正去找他了解的时候,他又说不出所以然。

只有你能把别人教会、讲明白,你才是真的懂!

2、没有自己的思考,只是复制粘贴代码

这个主要发生在技术人身上,很多人写技术文章,尤其是在 CSDN 平台上,你能发现很多这样的人,一篇文章大部分都是代码,意思让你自己领悟,好像谁不会看代码似的!

技术文章,除了贴代码,一定要有自己的思考,这段代码为什么这么实现?这么实现有什么好处?有没有更好的实现方式?

3、技术枯燥无味,学会用「比喻」

技术文章很容易让人读起来毫无兴趣,怎么让人有兴趣读完你的内容?学会用比喻,讲故事。

比喻和故事能让人更容易记住技术的原理。这里说一句老师的原话:

比喻有相似、夸张之处,相似是为了记住原理,夸张是为了记住关键差异。

就说 k8s 和 docker,你怎么给一个外行解释这是一个东西?官方就是使用比喻的方式,k8s 就是一个装满集装箱的邮轮,这个集装箱就是 docker。

4、学会讲发展史

一段原文

某项技术的应用场景源于设计的原始初衷,而原始初衷是从历史上的痛点发展过程中来的。
复杂的技术是很难讲清楚的,但是无论多么复杂的技术体系,都是从简单的应用场景逐渐演化来的,从发展历史角度来看,脉络就会很清晰

你去看淘宝的技术架构,你会发现它很复杂,但是如果从历史角度来分析。它的复杂度都是根据历史进程演化而来的,淘宝刚开始只是一个从网上买过来的单体架构。只是因为业务的发展,逐渐演化成这样的。

四、怎么让写作助力职业发展?

职场过程中,就算是程序员,也是离不开写作的。

你的技术文章、周报、月报、项目总结汇报、项目立项文档、试用期 PPT、晋升答辩 PPT 等等。

这些东西都离不开你的写作能力,而且,大部分程序员都是闷头做事,但是很难把自己做的事情讲清楚,白白吃了亏。如果你是一个写作能力优秀、表达能力优秀的程序员,那你的优势会非常大!

一个优秀的写作者,不仅能让复杂的事情变得容易理解,而且能够换位思考,实现更顺畅的沟通,更好的助力职场发展。

写作是最好的投资!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/822583.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Excel使用 CONCATENATE 函数或“”符号拼接多列数据

如果你想在Excel中拼接多列数据,你可以使用Excel的函数来实现。其中一个常用的函数是CONCATENATE函数或者更简洁的&符号。以下是如何使用这些方法拼接多列数据的示例: 假设有以下的数据: ABCJohnDoe25JaneSmith30BobBrown35 1. **使用…

mvn spring-boot:run运行报错

[ERROR] No plugin found for prefix ‘spring-boot’ in the current project and in the plugin groups [org.apache.maven.plugins, org.codehaus.mojo] available from the repositories [local (/Users/itkey/.m2/repository), public (https://maven.aliyun.com/reposito…

Python基于循环神经网络的情感分类系统设计与实现,附源码

博主介绍:✌IT徐师兄、7年大厂程序员经历。全网粉丝15W、csdn博客专家、掘金/华为云//InfoQ等平台优质作者、专注于Java技术领域和毕业项目实战✌ 🍅文末获取源码联系🍅 👇🏻 精彩专栏推荐订阅👇&#x1f3…

spring02:DI(依赖注入)

spring02:DI(依赖注入) 文章目录 spring02:DI(依赖注入)前言:一、构造器注入(constructor)二、set注入:分析: 1. Student类:2. Addres…

编程入门(二)【计算机基础三】

读者大大们好呀!!!☀️☀️☀️ 🔥 欢迎来到我的博客 👀期待大大的关注哦❗️❗️❗️ 🚀欢迎收看我的主页文章➡️寻至善的主页 文章目录 前言五、常用软件的相关介绍六、操作系统的相关介绍七、Window11系统的基本操…

关于fail-fast机制和集合中删除元素报错这件事

我们由简到繁来叙述这件事 集合中删除元素报错 这个是很很基础但每一个程序员开发之路上都会遇到的报错,即ConcurrentModificationException 现象:在加强for循环中,使用集合本身的方法去删除了某个元素,比如 for (String obj:…

The application could not be installed: INSTALL_PARSE_FAILED_MANIFEST_MALFORMED

运行报奇怪错误&#xff0c;然后加一句android:exported“true”&#xff0c;就可以了 &#xff0c;如下 <activity android:name".MainActivity" android:exported"true"><intent-filter><action android:name"android.intent.action…

Ansible离线安装

目录 概述失败成功离线安装包 概述 Ansible rpm离线安装 失败 yum -y install ansible --downloadonly --downloaddir./ansible [rootVM-16-2-centos ~]# yum -y install ansible --downloadonly --downloaddir./ansible 已加载插件&#xff1a;fastestmirror, langpacks Re…

浏览器内使用JS和椭圆曲线密钥交换

源码&#xff1a; 之前使用GO已经可以实现秘钥交换了&#xff0c;这里使用浏览器发送数据&#xff0c;与后端服务实现秘钥交换&#xff0c;记录一下实现的基本函数&#xff1a; // 生成密钥对&#xff0c;并保存到全局变量中async function createDHPair() {// 生成新的ECD…

vue3 源码解析(7)— diff 算法源码的实现

前言 vue3 采用的 diff 算法名为快速 diff 算法&#xff0c;整个 diff 的过程分为以下5个阶段完成。 处理前置节点处理后置节点处理仅有新增节点处理仅有删除节点处理其他情况&#xff08;新增 / 卸载 / 移动&#xff09; 这里我们先定义新旧两个节点列表&#xff0c;接下来…

数据结构速成--栈

由于是速成专题&#xff0c;因此内容不会十分全面&#xff0c;只会涵盖考试重点&#xff0c;各学校课程要求不同 &#xff0c;大家可以按照考纲复习&#xff0c;不全面的内容&#xff0c;可以看一下小编主页数据结构初阶的内容&#xff0c;找到对应专题详细学习一下。 目录 一…

JavaWeb--前端--03Vue入门

Vue入门 1 Vue概述2 快速入门3 Vue指令3.1 v-bind和v-model3.2 v-on3.3 v-if和v-show3.4 v-for3.5 案例 4 生命周期 1 Vue概述 个完整的html页面包括了视图和数据&#xff0c;数据是通过请求 从后台获取的&#xff0c;那么意味着我们需要将后台获取到的数据呈现到页面上&#…

多数之和算法题总结(二十三天)

1. 两数之和 题目 给定一个整数数组 nums 和一个整数目标值 target&#xff0c;请你在该数组中找出 和为目标值 target 的那 两个 整数&#xff0c;并返回它们的数组下标。 你可以假设每种输入只会对应一个答案。但是&#xff0c;数组中同一个元素在答案里不能重复出现。 你…

RDP连接Ubuntu远程桌面

之前一直用vncviewer&#xff0c;效果不佳&#xff0c;Microsoft Remote Desktop连ubuntu上的win虚机很好&#xff0c;多了几个工作环境&#xff0c;于是再度试一下用RDP连Ubuntu远程桌面。 几点注意事项 先安装xrdp: apt install xrdp 踢掉ubuntu上的登录用户&#xff0c;例…

OSPF - 链路状态路由协议

IGP 外部网关路由协议&#xff1a; OSPF &#xff0c; IS-IS EGP 内部网关路由协议&#xff1a; BGP 协议算法&#xff1a; 距离矢量路由协议 链路状态路由协议 lsdb:链路状态数据库 - 存放lsa的地址 RIP&#xff1a;有方向的矢量&#xff0c;距离矢量路由协议&#xf…

PHP-extract变量覆盖

[题目信息]&#xff1a; 题目名称题目难度PHP-extract变量覆盖1 [题目考点]&#xff1a; 变量覆盖指的是用我们自定义的参数值替换程序原有的变量值&#xff0c;一般变量覆盖漏洞需要结合程序的其它功能来实现完整的攻击。 经常导致变量覆盖漏洞场景有&#xff1a;$$&#x…

最前沿・量子退火建模方法(2) : Domain wall encoding讲解和python实现

前言 上篇讲的subQUBO属于方法论&#xff0c;这次讲个通过编码量子比特的方式&#xff0c;同样的约束条件&#xff0c;不同的编码&#xff0c;所需的量子比特数是不同的。有的编码方式&#xff0c;很节省量子比特。比如&#xff0c;这次要讲的Domain wall encoding。 一、Doma…

Vue.js前端开发零基础教学(六)

学习目标 了解什么是路由&#xff0c;能够说出前端后端路由的原理 掌握多种路由的使用方法&#xff0c;能够实现路由的不同功能 掌握Vue Router的安装及基本使用方法 5.1 初始路由 提到路由&#xff08;Route),一般我们会联想到网络中常见的路由器&#xff08;Router),…

CSS3 max/min-content及fit-content、fill-available值的详解

c3中对width的值多了几个值&#xff1a;fill-available, max-content, min-content, 以及fit-content。 1.width:fill-available 我们在页面中扔一个没有其他样式的<div>元素&#xff0c;则&#xff0c;此时&#xff0c;该<div>元素的width表现就是fill-availabl…

杰理-701-更换字库

杰里-701-更换字库显示 工具&#xff1a;链接&#xff1a;https://pan.baidu.com/s/1yMDatiRCaJj2ioKXF-H8GQ 把使用的字库文件放进该目录下 生成后的字库文件需要修改名称 把修改好名称的字库文件放到该目录下替换 代码,把所有语言的PIX修改未新替换的字库文件&#xff08;保…