技术写作的首要诀窍

1,技术写作的好坏,跟语文水平关系不大,更多是一个技巧问题

2,技术写作的评价标准:表达是否清楚明白。它不需要华丽的词藻、巧妙的比喻、深刻的感悟,只需要把问题说清楚。

3,把问题说清楚的关键,在于思想是否清楚。当想清楚了一个问题,只要掌握几个基本诀窍,就能写出一篇很好的技术文章

4,技术写作的首要诀窍:文章采用单线结构。

"单线结构"(也称"线性结构"),指的是一篇文章只说一件事,按照线性顺序进行叙述,由浅入深、循序渐进、平铺直叙、层层递进。

5,只要采用了单线结构,技术文章就不会太差。即使内容是难懂的,至少结构是清晰的,一环扣一环,读者能知道自己卡在哪一环上。只要克服了这个难点,就能继续往前走,不会有陷入迷宫、找不到方向、如坠五里雾中。

6,有的问题比较复杂,涉及多个因素,可能是星状结构。也可能是"层次结构"。建议把这个问题拆分成多篇文章,每篇文章保持单线结构,坚持做到一篇文章只讲一点,而且争取把这一点讲透。

7,单线结构说起来容易,做起来难。难就难在,人类的思想不是单线的,而是多线的,甚至是非线性。要把混乱而跳跃的思维,整理成单线结构,表达出来,让他人理解,通常都需要反复推敲和提炼。

8,老外的一篇文章

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,862评论 2 59
  • 前言 非常感谢大家抽出生命中宝贵的一段时间来听我接下来的一大段关于写文章那些事的唠叨。写文章的好处看看《觉醒年代》...
    星光社的戴铭阅读 1,219评论 2 7
  • 一、前言 作为一名程序员,经常在网络上查找各种各样的资料。此时,会检索到很多优秀的技术文章。一篇好的技术文章,可能...
    b60c18911cf4阅读 244评论 0 0
  • 后端架构师技术图谱 最后更新于20180502 数据结构队列集合链表、数组字典、关联数组栈树二叉树完全二叉树平衡二...
    01_小小鱼_01阅读 1,832评论 0 38
  • 数据结构队列集合链表、数组字典、关联数组栈树二叉树完全二叉树平衡二叉树二叉查找树(BST)红黑树B-,B+,B*树...
    jackcooper阅读 3,301评论 1 50