读书笔记： 技术文章写作指南

学习笔记： 技术文章写作指南

学习笔记： 技术文章写作指南

• preface

  • 在阅读论文之前， 我发现自己并不懂自注意力机制结构， 看这方面的代码比较头疼。 因此需要学习一些。

• content

  • 支撑写作的是哪些要素

    • 首先你自己要有输入， 输入的质量高且有效果。
    • 训练思考能力 ： 1，习惯追求食物的本质、习惯建立知识的链接
    • 强化输出 ： 1天天写， 2文章中有故事又有观点 3 建立自己的写作流程， 固定套路。 4. 建立反馈系统

  • 为什么你必须公开写作

    • 人是社会化动物，有压力有反馈
    • 点赞少说明没得到别人的认可， 阅读少说明你的话题不是大家关心的挂梯， 评论少是你没调用作者参与感。

  • 好的文章标准

    • 首先提供了新的认知， 创造了价值。 比如很多文章来给读者普及知识。
    • 信息量大而且密度高。 也就是说文章可以长， 但是信息量要够多， 要不然就显得啰嗦。
    • 逻辑和论证 精彩。
    • 容易理解， 不能高冷。
    • 真诚沟通，不装。
    • 这里其实可以看看腾讯工程中的文章分享， 真的可以。

  • 写作是手段而不是目的

    • 为什么要有目的的写作

      • 明确写作目的， 这篇文章写出去能有什么收获。 明确阅读对象。 明确阅读场景是什么地方。

    • 采用双向沟通的写作

      • 让对方觉得在聊天， 而不是只是传授知识。 因为人的阅读能力只要还是和说话方式挂钩， 比较喜欢接受这种沟通的交流。 注重对方能不能接受，而不是表达准确。

    • 从作者逻辑切换到读者逻辑

      • 从表达逻辑到倾听逻辑
      • 从得到粉丝角度分析维度到给予别人角度。

  • 其他技巧

    • 一个格式化的写作套路

      • (1）我要说的是什么概念?(2）这个概念为什么重要?(3）这个概念通常被如何误解?(4)）这个概念实际上是怎么回事儿?(5）这个概念有什么意义?
        (6)如何正确使用这个概念?
        (7）错误使用这个概念有什么可怕之处?
        (8）这个概念与哪些其他重要概念有重要的联系?

      • 再高级一点的写作公式比如以下六条。(1）场景化写作，引出一个痛点话题。(2）针对痛点话题，提出一个新鲜观点。(3）正面论证这个观点。小标题＋案例。(4）反面论证这个观点。小标题＋案例。(5）总结这个观点的意义、价值。
        (6）给出具体的执行建议，呼吁大家去做。

      • 但是上述都是一种非技术类型的写作。 如果是写技术类的文章， 就需要先说自己这个文章讲啥， 然后讲一下为什么选这个技术（对比优劣）， 最后将一下怎么做的（给出细节， 按照软件工程的细节最好，图表并茂）， 最后总结。

    • 题目大众一些， 话题要聚焦于用户关注的点， 带来新的知识。

    • 开头带来价值和重点， 让用户觉得有必要读下去。

    • 小标题要总结好。

    • 完成比完美更好， 完美是动态的过程， 他是基于完成过程中进行的。 不是一开始就构思好的。

    • 多用名词动词， 少用形容词

      • 神经心理学认为，人的爬行脑（也就是控制人欲望的那部分大脑）更喜欢视觉化的信息，而不是抽象的信息。所以，我们进行内容表现时，要多做视觉化表达，少用抽象化表达。具体来说就是两个技巧:少用形容词，多用名词、动词。

        • 例如 ： 你写 PPT 时，阿拉斯加的鳍鱼正跃出水面。你看报表时，梅里雪山的金丝猴刚好爬上树尖。你挤进地铁时，西藏的山鹰一直盘旋云端。你在会议中吵架时，尼泊尔的背包客一起端起酒杯坐在火堆旁。有一些穿高跟鞋走不到的路，有一些喷着香水闻不到的空气，有一些在写字楼里永远遇不见的人……

• summary

  • 总的来说收获不是很大， 这里面的内容其实大部分自己都知道， 而且他的写作技巧是针对所有人的文章， 我想写的只是针对技术人员的文章， 因此他的方案并不适用于我，我得技术文章应该按照列大纲， 精简文字， 多多举例， 善用图表，反复修改和做好排版等工作。 其实这部分可以参照极客时间里面的王铮数据结构写作风格。

• reference

  • 技术文章写作技巧 - 少个分号的文章 - 知乎
    https://zhuanlan.zhihu.com/p/144081777
  • 教你写好技术文章 - Linux学习的那些事儿的文章 - 知乎
    https://zhuanlan.zhihu.com/p/371420674
  • https://www.zhihu.com/pub/book/119632521