程序员写作能力提升指南

前言

“本文,是笔者自我总结,献给那些希望提升自己的技术写作能力的人,或者你想了解如何写作的人,看完你能收获,清晰写作目标,写文的规范,如何找到自己的写文风格等等。”

每个人的经历、观点和背景都不同,一万人读同一篇文章会有不同的看法,在阅读之前,希望能够:

  1. 保持绿灯思维,个人情况不同,还需要各位读者不要太早做出评价
  2. 保持思考,笔者的文章的观点,不一定是正确,可以最后在评论区提出疑问
  3. 尊重别人的观点,以善意和包容的的态度去审视别人的观点
  4. 文章以大白文,流水账的形式写作,并没有太好的文笔,目的是为了浅显易懂

一、为什么要写作

笔者背景,本职工作是前端开发,98年,大专,最近审视自己的 JavaScript 基本功。所以在更新我的专栏,手摸手带你学JavaScript ,目前更新基础篇,进阶篇已经在创作了。

好的,我们回到主题,为什么要写作?

在某些时刻,你是不是也有过写作的冲动,但是热情总是消失的很快,又或者是找不到写作的方向等等一系列问题…

我们要思考一个模型,程序员写作,能收获什么好处?笔者给自己画过一张示例图如下所示:

写作-技术.png从上图中我们能清晰看见,我自己就是以这种理念来写作的,写作以来我最大的感受还有这些

  1. 把技术通过文字表达给大家,把一些概念和思想组织成大家可以理解的内容,并加深自己对知识点的理解。
  2. 写文也是一种知识分享的形式,大家通过对我的文章阅读,反馈,可以帮助我归纳总结,所以,写文的时候,会考虑的更谨慎一些。避免出现错误。
  3. 长期的坚持,慢慢有自己的影响力,可以帮助很多其他开发者,每次的阅读量和点赞会给我产生多巴胺,形成正向反馈。

以上就是笔者,一些浅薄的观点,下面我们一起探讨如何找到自己的写作目标

二、清晰自己的写作目标

1.确定自己的写作主题

选择一个具体的主题或者话题

通常选择好自己的写作主题能事半功倍,可以运用这样一个思考模型

你最近在学习一些新特性,你理解之后,迫不及待的整理了一些思绪,想给大家分享一篇

最近行情非常困难,我想整理一些面试题,然后帮助大家,并巩固和审查自己的基本功

我想写一篇感悟,md,行情好难,抒发自己的情绪,又或者是解决了一个问题,我收获到了什么,实在不行我们就前端以死为题

其实,点进来的靓仔(女),或多或少都这样想过,毕竟程序员理解能力还是够的,当大家知道如何选主题之后我们就可以围绕这个主题进行创作

2.确定自己的写作目的

这也是非常关键的一步,你选择这个主题之后,你是要教育读者、解决问题、启发思考还是表达个人观点。明确自己的创作可以使你的文章更具 针对性效果

3.你想要表达的主要观点和传达的信息

确定你文中想表达的核心价值是什么,要和你的文章保持一致,并且逻辑清晰,有自己的思考和见解。保证你的文章围绕这些观点进行组织和展开。

为了避免一些不必要的麻烦,创作时候,不要去传达一些真刑的事情

4.文章的结构、大纲

这里我就以我自身为例,虽然不一定是最佳实践,但是各位读者可以在这个基础上优化

  • 知识文章结构体系、大纲

    知识.png

  • 分享心得结构体系、大纲
    分享.png

其他内容,各位可以在平时阅读其他优质博主的同时,学习总结,然后有一套自己的结构

简单公式

  1. 说在前面 本文的一些背景 本文是以什么为题这一类
  2. 内容以主题为准,图文并茂,或者代码片段,相关链接,码上掘金,GIF
  3. 结语

5.文章的受众群体

了解自己的目标读者,具体怎么了解我们可以通过掘金的阅读量和点赞收藏分析出来,就是在创作者平台中观察数据。

但是,每次创作还是要遵循自己的本心,其实写文,有很多方向,可以简单尝试,最后选择一条你自己的方向。(小声逼逼:也就是读者喜欢的方向,哈哈哈~~~)

具体可以这么做

  1. 研究目标读者,如果你可以和他们交流的话
  2. 适应读者的需求,不管是黑,还是反馈,还是夸赞,你都平常心看待,然后看看自己的内容,深度和风格。能否在下次引起读者的关注
  3. 写作风格,语言表达,表达上,尽量不要写什么太专业的词语,或者你能比喻形容描述清楚,保证文章可读性。为什么我不说写作风格,因为我在下面写

三、如何找到自己的写作风格

首先你想想自己的性格是什么,文艺青年,嘻嘻哈哈,简单朴素,还是有一肚子墨水,也有可能是一肚子坏水。

你可能找不到,没事,我来给你一些建议:

  1. 多读其他人的文章,阅读不同风格文章,小说(当然不是一看就是看一天)、新闻、散文、技术文档的等等。通过阅读你可以借鉴他们的写作技巧和风格,发展自己的独特的风格
  2. 多尝试,可以写的正式、幽默、故事化、理性等等,不要太专业性了。可能会劝退别人,比如说笔者我。然后发现你自己喜欢哪种风格,这样文章才有你自己的个性和思想
  3. 真实和自然,不用试图模仿别人,在文中让读者体会你的真实性和自然性。自然而然地喜欢你地文笔

四、写文规范

统一的规范可以让文章更易于阅读和理解,提高文章的质量和可读性。程序员一定学会使用 markdown ,下面是我整理的一些语法和规范,很干,记得喝水:

1.下面是一些常用语法

  • 标题: # + 空格

  • 字体: **这是黑体加粗** 黑体加粗*这是斜体* 这是斜体

  • 引用:

    > + 空格

    这是一段引用

    >> + 空格

    这是嵌套引用

  • 列表:

    * + 空格

    • 第一项

    1 + . + 空格

    1. 第一项

    - + 空格

    • 第一项

    + + 空格

    • 第一项
  • 代码块:

    `` + 空格 中间插入要输入的内容 Hello World

  • 代码片段:

    ``` + 语言类型 + 空格

    代码片段
    
  • 链接:

    []() [] 中输入文本信息 () 输入链接地址 可以是本地可以是外部链接

  • to-do 任务列表:

    -[x] + 空格 注意写入顺序

    1. 先写完 -[x] 然后鼠标退到 – 和 [x] 的中间空格

    2. 最后在 [x] 后面空格 就会生成任务列表

    • 任务列表

2.标题规范

开头标题使用 ## 二级标题,后续的子标题不能超过上一级标题

## 一级
### 子标题
#### 子标题下面的子标题

3.字体规范

在使用 注意总结提示 等等这一类关键词的时候,给读者告知关键词后续的内容十分重要,又或者是在写文过程中,告知读者有些词语是要注意的,例如一些概念:排他思想

4.段落规范

目前不采用,首行缩进的方式写文,但是标题之后记得多留一行

### 3级标题
enter 回车换行
### 3级标题

这样做的目的是:方便更改,而且美观

5.符号规范

文章的使用的所有符文,都必须以中文输入法 + 半角形式书写

6.内容规范

  1. 在使用 `` 语法的时候,留出前后空格留白,方便后续后续更改不会影响其他排版
  2. 在输入 英文的时候,留出前后空格,方便阅读者复制,或者自己复制
  3. 在使用 **** 语法的时候,留出前后空格,方便更改
  4. 在使用 ** 语法的时候,留出前后空格,方便更改
  5. 文章保证加入自己的思想,这样才能在写作过程中学到知识
  6. 在引用其他作者的时候,表明内容是别人的

7.写一些面试相关的规范

<details>
<summary>查看答案</summary>
</details>

效果

查看答案

我是输入的答案

当涉及到换行的时候 使用 `br` 换行即可

<details>
<summary>查看答案</summary>
1. 第一行<br />
2. 第二行
</details>
查看答案

1. 第一行
2. 第二行

五、笔者用的一些工具

如果我后续中有其他更新中有其他更新会更新这里,目前我使用的如下:

  • 写文工具:Typora
  • 截图工具:Snipaste
  • 白板工具:processon

六、结语

人的一生中,时间就像静静流淌的水,无情地带走我们的日子。在岁月中的河流中,往事逐渐褪色。有人说,那些只是过往云烟,不值一提;又有人说,那些消逝的记忆就像黑白默片;

忽然一阵清风拂过你的脸颊,思绪就像绵绵细雨,游走到你的记忆深处。这时,你想到你第一次选择专业时候的样子,你想到你打出 Hello World 这一段程序的样子,你想到在记忆洪流中写下的第一篇文章时的样子。

突然一声雷响把你从思绪中拽了回来,你好像明白了什么,有一件事,一直影响着我,让我至今难忘。我总是思前想后,但是我的每一次迈步,都让我为自己写下新的篇章。

这一路上走走停停 顺着少年漂流的痕迹

迈出车站的前一刻 竟有些犹豫

而长野的风 依旧那么暖

风吹起了从前

感谢您花费宝贵的时间来阅读这篇文章,希望可以帮助到大家创作属于你自己的内容,如果大家有宝贵的意见可以在评论区和我留言讨论。

© 版权声明
THE END
喜欢就支持一下吧
点赞0

Warning: mysqli_query(): (HY000/3): Error writing file '/tmp/MY722c7z' (Errcode: 28 - No space left on device) in /www/wwwroot/583.cn/wp-includes/class-wpdb.php on line 2345
admin的头像-五八三
评论 抢沙发
头像
欢迎您留下宝贵的见解!
提交
头像

昵称

图形验证码
取消
昵称代码图片