框架搭建

写作套路

技术科普

image.png

原理剖析

image.png

功能实现

image.png

使用教程

image.png

问题解决

image.png

项目总结

image.png

会议记录

image.png

工具测评

image.png

技术人文

image.png

职场故事

image.png

其他技巧

1. 不同的账号主体

同样类型的文章,如果发布的账号主体不同,则文章的结构也会有所不同。

2. 不同的阅读对象

同样的主题,给同事看的和给同行看的文章结构也是大不相同。

内容

辅助内容

代码片段

优先使用代码块功能
代码需精简

技术文章中的代码块务必要精简,除非是专门提供给读者复制用的完整代码。

我们日常做事也是如此,你要想做到极致,一定会有很多意想不到的细节工作去做,这些都属于超出预期的精力,很多人就不愿意做,他宁可花大把的时间和精力做十件平庸的事情,也不愿意做一件极致的事情,非常的不理性,典型的用身体上的勤劳来慰藉心理上的懒惰,最终往往一事无成,反而还抱怨世间不公。

辅助图片

示意图、表情图和视觉图。

关于截图
  • iShot
自制线框图
版权问题

配图素材不容忽视的一个大问题就是版权问题。

演示视频

GIF 录屏或者视频录屏的效果更好。

录屏工具推荐

在线案例

吸引力的内容

想要文章受到关注和追捧,最核心的是提高你自己的专业技术水平,成为某个领域的专家。

形式创新

  • 传统故事陈述
  • 对话体
  • 剧本杀体
  • 会议模拟
  • 聊天记录模拟

角度新颖

同样一个内容,如果换个角度阐述,味道就会变得有所不同。 回到技术写作,技术概念要比实物飘渺,凭空思考往往想不出特别的角度,此时,可以拿出纸和笔,勾勾画画,思路很快就会打开的。

在 JS 中,数组遍历方法有很多:for 语句,forEach,for…in 和 for…of 是比较常见的,我们平时选择使用哪个遍历方法的考虑因素是:代码简洁易懂、性能、上下文支持等。 所以,我们就可以把原来中规中矩的数组遍历方法介绍变成类似下面这样的内容:

  • 以数量为切入角度:我一共知道 12 种数组遍历方法,你知道几个?
  • 以对比为切入角度:for/for…in 和 for…of 有什么区别?
  • 以性能为切入角度:常见 JS 数组遍历方法速度测试
  • 以使用场景为切入角度:日常开发,我该使用哪个数组遍历方法?
  • 以技术 Tips 为切入角度:forEach 不支持 break?试试使用 some/every 方法进行数组遍历

棱角个性

有两类技术文章是最看不进去的,一类是文档式的,还有一类是论文式的,比这两类还看不进去的就是专利文档。 什么是有情感的内容呢?

  1. 非上帝视角,而是以自己或他人为视角进行描述;
  2. 抒发个人的情绪,表达个人的见解。

举例说明: 上帝视角: 数组遍历有如下方法: 1, 2, 3, … 个人视角与情绪表达: 我今天才知道,数组遍历原来有这么多方法: 1, 2, 3…

作用有两个✌️:

  1. 枯燥的文章千篇一律,好看的文章各有不同,区分度也意味着新鲜感,文章更有吸引力;
  2. 当这种“独特的情感”不断重复和加强后,会逐渐形成你的标签,有利于品牌的建设。

总而言之一句话:你是什么样的人,就使用什么样的风格!

换位共情

面向读者写文章。 每写一段内容,都进行一次情境模拟——

  • 如果我是小白,这些术语懂吗?
  • 如果我是读者,好理解吗?
  • 是不是用个耳熟能详的东西类比下?
  • 是不是代码要简化下,加上注释?
  • 是不是这里应该放个图?
  • 是不是这里应该加个演示?

一个知识点要想深入浅出,前提就是作者本人的理解足够深入

内容严谨

技术文章要想品质好,其中很重要的一点就是你所说的结论务必正确,也就是对每一句话负责。

技法高明

  1. 首先第一个,尽量的口语化,少用那些书面化的词汇,除非你是写技术文档、工作汇报或者专利文档。因为我们写技术文章的目的是传道受业解惑,让别人更容易理解才是我们的目的,而口语化的语言仿佛就是和人在聊天一样,更亲切自然,也更容易理解与接受。
  2. 其次,句式可以灵活多变,语气有强有弱,而不是陈述句一条道走到黑。比如可以适当地使用疑问句或反问句。

疑问句:你觉得 for-in 和 for-of 哪个性能更高呢?下面来揭晓答案……反问句:forEach 需要执行 function,性能怎么可能比不产生任何上下文开销的 for 循环还高呢?

可以适当的停顿或重复来表示强调,例如:

注意,注意,注意,重要的事情说三遍,千万不要…

3.善用比喻,学会举例。 4.最后,可以适当玩梗,或者使用一些网络流行语、谚语、歇后语、诗词等进行点缀。

保持真心

推广

品牌运营与传播

账号名称与头像

什么样的账号名称与头像是适合品牌运营的呢?

  1. 识别度高;
  2. 与主体关联;

强化文风与措辞

让别人记住你的一个最简单的方式就是不断重复。

这种重复可以是类型、可以是风格、可以是口头禅,甚至是某个配图、某个特征,都可以。

  • 非技术标签
  • 技术标签
  • 可以想一个固定且好记的措辞,然后想办法在每篇文章中呈现。

灰太狼的“我一定会回来的”。

  • 又包括配图,可以使用某个固定的配图。

保持棱角

防盗技巧

    1. 版权声明
    1. 图片水印
    1. 内容植入
    1. 软安利

作品价值最大化

抓住版权

多平台经营

内外开花

文字作品→PPT分享→视频讲解。

微创作

  1. 技术 Tips
  2. 思考想法
  3. 委婉暗示

体系化创作

所撰写的内容尽可能地体系化创作。

量变产生质变,当你的作品数量积累到一定程度之后,这些作品是可以进一步包装,进行二次销售的。

技术写作指南 - 张鑫旭 - 掘金小册


Input 实用技能 写作

来自:原文地址