闲聊技术文章的写作姿势 - 约伊兹的萌狼乡手札

不过真的有一种正确的姿势么 _(:з」∠)_

其实咱为啥写这个 ~~几乎全是瞎扯~~ 的博客的一个主要原因就是有时找不到合适的文章或文档 😂😂

所以,技术文章怎么啦~ (╯T︿T)╯ ┻━┻

擅长前端的 ~~老司机~~ 卡夫 ( frantic1048 ) 推荐了一篇叫做技术文章常见的 5 个问题的文章. o(*￣3￣)o

里面提到了撰写技术文章遇到的常见的问题:

目的不明确。“所以，搞着些玩意儿是要干啥？”

文章内容太过狭窄。“噢，这篇文章只面向 20 岁的见习风系魔法学徒使用，不看了”

贴代码没注释。“这个野生的咒语是干啥的？”

前后不一致的口吻。“我感觉快要精分了 ~(>_<~)”

写到最后没有个结论。“(..•˘_˘•..)”

—frantic1048 in 知乎

( ,,´･ω･)ﾉ"(´っω･｀｡)

提前注明一下 : 下面的栗子纯属虚构呐~ 如有雷同..... (放心这不会发生的😋

技术文章问题之一 : 目的不明确 <(=﹁"﹁=)>

~~由于深受语文教育的毒害~~ ,一般都会认为一篇文章都要有一个主要表达的意图或是观点呗 ( 没错就是那个众人寻他千百度却在灯火阑珊处的中心思想😂😂 ), 当然汝说的如果是一篇 ~~形散神聚的~~ 散文那就又是另一个怎么也解释不清的玄学了 ~~(明明是我先的......~~

然而实际情况是,有时容易搞不清楚文章的主题,典型的情况就是...... ( 咱给忘了 (つд⊂)

试想一下一个希望看到某个主题的读者在看到全篇都在讲另一个主题的时候的感觉, ~~真的好想把浪费咱时间的作者咬死 😂😂~~

技术文章问题之二 : 文章内容过于狭窄 ~(>_<~)

内容过于狭窄就容易给读者 "这篇文章不适合咱" 的错觉,于是就关掉了......

有可能是因为很多时候自己的博客有点像自己的笔记,解决一个问题以后写一篇,于是整片文章都在讨论如何解决某一个具体的问题,看着就 "内容过于狭窄" 了 | ω・`)

在这里咱要好好反省一下自己,因为咱好像一直在写像是教程一类的东西于是就没有多少深度 😂

技术文章问题之三 : 贴代码没注释 (╯>_<)╯ ┻━┻

写代码没注释就像汝拿着一本魔法书却不知道怎么使用呐~

“这个野生的咒语是干啥的？” _(:з」∠)_

比如上面那个歪果仁提的栗子：

<!-- offset 2 -->
{{ range $index, $element := .Site.Pages }}
    {{ if gt $index 1 }}
    <li>
        <span class="date">{{ .Date.Format "Jan" }}
        <strong>{{ .Date.Format "2"}}</strong></span>
        <h3><a href="link">{{ .Title }}</a></h3>
        <p>{{.Description}}</p>
    </li>
    {{ end }}
{{ end }}