谈谈我的写作技巧

2024-01-01 18:32
文章标签 谈谈 写作技巧

本文主要是介绍谈谈我的写作技巧,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

640?wx_fmt=jpeg


写作是一项很重要的软技能,无论是写技术文章、工作邮件还是晋升PPT,好的写作技巧都可以起到事半功倍的效果,大家不能忽视,本文就和大家谈谈这个话题。

针对所写内容,必须深入理解,这样你才能准确地表达出来,下面是我的一些写作指导意见。

针对简单概念
你要介绍的全面,理论配合demo,能够让一个不懂的人看了之后懂了。

针对有点难度的概念
你要一步一步地详细介绍,让刚入门的小伙伴们能够仿照你的例子做出来。

针对底层的东西
比如源码,你要能把大致流程说清楚,并且能够结合源码分析出上层的东西。

这是我所认为写一篇好的文章所应该达到的,总之我们要明白,写出来的文章主要是给别人看的,写的时候要考虑这么一个问题:如何写才能让别人更好地理解,这样好文章自然就出来了。

下面是一些具体的指导思想:

  • 正确

  • 全面

  • 严谨

  • 可重现

  • 写作技巧

正确、全面和严谨,我相信大家都懂啥意思,下面主要说说可重现和写作技巧。

可重现

什么叫可重现?就是读者按照你的文章一步步来,可以达到文中的效果。比如环境搭建,文章要把每个步骤都详细地写出来,必要的时候要配合图片来说明。有时候你可能会觉得有些步骤读者应该已经知道,所以文章就不用再提了,这是个错误。我们写作的时候不要想当然,读者千千万万,总是会有很多人不知道。

写作技巧

假设我们写作的文章已经满足了“正确、全面、严谨和可重现”,那么如果你不懂写作技巧,那这篇文章仍然是一个败絮其外、金玉其中的东西,直观点来说:大多数情况下,败絮其外的东西就是一个垃圾,没人会有兴趣了解你的金玉其中。

言归正传,关于写作技巧我说下我的观点:

  • 文章组织思路清晰

  • 语言简洁易懂,不要啰嗦,也不要故作幽默

  • 排版清晰美观,让人有阅读欲望,让人可以一眼看穿文章的组织思路

下面分别做说明。

文章组织思路清晰

文章的组织思路很关键,它可以从如下几个点来描述:

  • 文章的受众是新手还是高手

  • 文章的主题是什么,如何诠释这个主题

文章的受众是新手还是高手

这个很重要,像《Android开发艺术探索》这本书就是针对中高级读者,所以书中很多地方都没有手把手地去描述,这就是受众的原因。如果手把手去描述一些过程,读者会觉得多此一举,还会烦躁。

如果是入门文章或者入门书,那就要手把手来了。如果想当然地去省略一些步骤,那肯定会有很多新手很苦恼:“我按照书中的步骤一步步来,程序编译不过呀?” 可以想一下,这个时候读者心中会不会骂娘。

文章的主题是什么,如何诠释这个主题

一篇没有主题的文章只会显得杂乱无章,读者读后也会收获甚小。定好文章的主题后,那就要考虑如何诠释这个主题了。一般来说,我们需要从几个方面或者步骤来诠释一个主题,具体来说就是需要制定好几个子标题,每个子标题从一个方面来诠释主题。最好文章头部有个前言介绍下文章主题和背景,然后末尾再来个总结。

语言简洁易懂

如何做到语言简洁易懂?这个还真不好说,反正就是用正常的语言和措辞来描述当前问题,不要啰嗦,不要扯太多无关的,也不要故作幽默。

排版清晰美观

这个也非常重要,很多人写的文章看起来乱七八糟的,根本就没有读的欲望。美观不用我多说吧?每个人心中都有一个美的标准,如果没有,就想想平时读过的那些排版精美、赏心悦目的文章。

具体来说,注意下面几个点,就可以做到排版清晰美观:

  1. 注意标题层级和段落对齐。标题要有层次性,不同级别的标题,其样式要好区分。


  2. 标点符号不要乱用。知道什么时候该用句号,什么时候该用逗号,想想学生时代学过的语文课。


  3. 避免大段的文本。有时候有些人写作不喜欢分段,一段好几百字甚至上千字,看上去密密麻麻的,请问这怎么读?


  4. 不要一篇文章全是文字。最好来点插图什么的,图文混排的效果才是最适宜阅读的,而且有些概念纯文字也不好描述,一张图片立马清晰易懂。


  5. 代码中不要留无关注释。注释也要注意换行,代码块左边不要留空白。


  6. 日志只保留输出内容。去掉日期和包名等前缀信息,因为这些信息对读者没意义。


  7. 如果是微信公众号文章,还有考虑手机阅读的体验。由于手机屏幕宽度有限,所以代码要注意换号,不要出现一行代码不换行特别长的那种。



上面就是我对写作的理解,希望能给大家带来一些启发。那个,2个月没开赞赏了,今天开一次,大家支持一波吧,或者点个在看也行呀。






推荐阅读
普通人如何提高格局
谈谈我最近的一些思考
认清跳槽的本质,才能跳出跳槽的死循环


编程·思维·职场
欢迎扫码关注

640?wx_fmt=jpeg



  在看也是一种认可640?wx_fmt=gif

这篇关于谈谈我的写作技巧的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/560139

相关文章

谈谈我的8年编程自学辛酸史

2008年:第一个脚印 2008年的一个周末,我一如既往读着最爱的《电脑迷》和《电脑爱好者》,不经意间看见一篇文章,教读者如何自己制作一个exe来说生日快乐,于是,或许是我一生的道路就从这里开始了。 当时已经痴迷于电脑软件,但是身为初中生的我并没有机会玩电脑,只能苦苦地看着杂志记录好玩的软件,并没有想过真的要自己去制作软件。直到去新华书店买辅导书的一次契机,我看见了一本《Java语言教程》

作为面试官的一点点感悟,谈谈技术人的成长之路

因为工作上的原因,做过几次面试官,面试的同学有应届生,也有工作3-5年的老技术人。最近也频繁作为面试官帮助筛选候选人,中间有很多值得深思的东西,我记录了下来分享给大家。 以下观点仅为个人观点,不代表任何公司的立场。        01 面试不是简单的你问我答 一般来讲,作为面试官和候选人进行沟通的第一个问题是一般是自我介绍,整个自我介绍的情况应该控制在2分钟左右,阐述自己的教育背景,项目经历

谈谈经典限流方法—漏桶、令牌桶与Guava RateLimiter的实现

大数据技术与架构 点击右侧关注,大数据开发领域最强公众号! 暴走大数据 点击右侧关注,暴走大数据! 高并发的业务系统经常要接受大流量的考验,为了保证系统的响应度和稳定性,往往都需要对有风险的接口实施限流(rate limiting),更高大上的说法则是“流量整形”(traffic shaping)。限流的思想最初来源于计算机网络,有两种经典的方法:漏桶和令牌桶。本文先来稍微研究一下它们。

uni-app 扫码优化:谈谈我是如何提升安卓 App 扫码准确率的

一. 前言 之前的一个项目遭到用户吐槽:“你们这个 App 扫码的正确率太低了,尤其是安卓的设备。经常性的扫码扫不出来,就算是扫出来了,也是错误的结果!” 由于之前是扫描二维码的需求,所以没有对扫描条形码做严格的测试,客户提示说是条形码扫描效率低下。随即,我用自己的手机测试了一下,在安卓手机上确实有这样的问题,扫码准确率确实是低,尤其是条形码,扫码效率慢且不准确。扫描二维码的的效率还算可以

谈谈singelton单例模式

 单例模式是一种常用设计模式。该类只有一个实例,而且该类自行创建实例。         很多时候,服务器都只需要一个全局对象,这样方便协调系统的整体行为。比如系统的配置文件,系统只需要一个单例对象读取加载,其他对象只需要通过该单例对象获取配置信息。这样方便在复杂模式下对系统配置的管理。          java中常用单例模式: public class Singleton(

谈谈函数返回值为什么不能重载

一、函数的定义:       函数将有效的输入值变换为唯一的输出值,同一输入总是对应同一输出。       计算机本质是对抽象数学公式的具体实现,并以此具体实现来解决现实生活中的实际问题。 注:wiki百科对 “函数” 的定义如图,图比较大,请点击打开详情,左右拖动查看 全部内容。 二、悖论      反过来设想一下,如果返回值的类型 能用来 重载,那么对于相同的输入值,程序怎么决定

谈谈分组:sql的group by+聚集函数 和 python的groupby+agg

直接举例子+分析例子+总结来说,我先给几个表: 学生表:student(学号,姓名,年龄,院系); 课程表:course(课程号,课程名,学分); 学生选课表:sc(学号,课程号,分数); 啥时候用分组呢? 我由简至深来谈。 1、比如让我们查询各个课程号及相应的选课人数。 首先定位到sc表上,“各个”很明显就是要按课程分组,group by出场了,分组后对每组去统计选课人数,聚集函数出场了。

谈谈你对 Java 平台的理解?

谈谈你对 Java 平台的理解? 先谈谈我的理解: 一次编译,永久执行。依赖于jre的运行环境,jdk提供核心类库,java源代码经过javac编译为.class文件,.class文件经过JVM解析或编译运行,无需过多关心不同操作系统的差异性。 典型回答 Java 本身是一种面向对象的语言,最显著的特性有两个方面,一是所谓的“书写一次,到处运行”(Write once, run any

谈谈最近一段时间的工作

被原来的公司派出去做一个天津的项目,一个多月了,平均每天加班加到10点左右,周末都不休息,感觉好累啊。 最累的是心了,原来辛苦付出的四个月不是很被认可, 我是实习生,但是我不想一直做实习生, 这个月收获很多,把自己以前不敢尝试的后台狠狠的做了一次, 希望以后的日子自己能够越来越厉害! 近期打算辞职,过年以后向着北京出发!

谈谈nvm、nrm、pnpm的理解

谈一谈目前用的最多的也是主流的工具nvm、nrm以及pnpm的理解。 nvm 一般我们在公司开发,公司一般可能会有多个项目,可能有新项目也有老项目,不同的前端工程可能依赖的node版本不一样。这个时候就需要我们拥有多个node版本来开发不同的工程,如何安装多个node版本并可以随意的切换我们的node开发环境,这个时候nvm就能完美的发挥出自己的优势。nvm版本过低是不兼容vue3的项目的,我