写一篇技术文章要考虑的几个问题

2020-04-08

前言

写作可以记录自己的想法,如果写出来的作对他人有帮助则相当于创造了价值,这份内容记录的是作者我写初等技术文章时考虑的各个方面,我把它们一一写出来,与大家分享.

写一篇初等技术文章要考虑的各个问题

简单地描述

提问自己:我要打算介绍的这个概念,自己能否用足够简单的语言把它给介绍出来,并且听了也通俗易懂?如果读者对这篇文章所要讲解的概念知之甚少,它能读懂吗?预备知识的门槛是过高了吗?

主旨界限

提问自己:我是否清楚这篇文章要讲解哪些内容,以及哪些内容可以不在这篇文章中讲解,我读了这篇文章之后,能否大概知道这篇文章都讲了些什么?

图形化描述

提问自己:我能否用生动详实的图形图像,甚至视频和音频,甚至JavaScript动画来对要介绍的概念进行描述?能否用图形的方式,让复杂的概念变得容易理解?

产生的价值

提问自己:我写这篇文章会为读者带来价值吗?或者说,更基本地,我自己作为读者,这篇文章会在以后为我自己带来价值吗?这篇文章容易让人觉得「对自己有帮助」吗?大家会对我所写的感兴趣吗?

用实例诠释

提问自己:我能举出什么实例来诠释我所要讲解的概念?我可以在Mathematica记事本中代入具体数字进行一遍演算吗?我可以写一段程序来展示输出结果并接受程序的大概步骤吗?我可以介绍具体的应用并且做出一个Demo应用来吗?

更一般地,经营一个博客面临的问题

隐私保证

要考虑:访客发往这个网站的数据经过了加密吗?网站发回给访客的响应经过了加密吗?访客是否会访问到假冒的这个网站?

反馈通道

要考虑:访客能否联系到站长?访客能否方便地发表评论?站长能否看到访客的反馈?

经验交流blogwriting

简单数独问题的数学方程式表示

HTTPS证书:原理、签发、部署和验证