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


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

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

所以,技术文章怎么啦~ (╯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 }}

尽管因为咱以前用过 Jinja2 所以知道这是 Jinja 模板的一部分,但肯定有好多人看到 HTML 就一阵惊慌失措啦 ( 更别提 HTML 里还有一堆大括号啦 (╯>▽<)╯ ┻━┻ )

在这里咱要好好反省一下自己*2,好像咱也经常忘记写注释......

顺便给 frantic1048 点个赞 ( 例如这篇 )

o(* ̄3 ̄)o

技术文章问题之四 : 前后不一致的措辞 ( ̄ε(# ̄)☆╰╮( ̄▽ ̄///)

比如前面用 "我" 后面不知道到了哪里就变成了 "我们" 这一类的问题,

读起来感觉自己都要精分啦 (╯@﹏@)╯ ┻━┻

技术文章问题之五 : 没有总结 “(..•˘_˘•..)”

......

上面就是一个绝佳的栗子 😂😂

那么啥样的姿势比较好咧? ~(>_<~)

其实上面那篇文章里也给出了四个建议 😂😂

建议之一 : 拥有个性 (σ≧∀≦)σ

要知道汝写的是文章而不是 死板的 API 文档呐~ 一个好的写作风格说不定可以帮汝拉来新读者哟~ 😋

建议之二 : 但是也不要个性过了头 <(ノ=﹁"﹁=)ノ┻━┻

既然是技术博客嘛,一定的严谨和专业性还是有必要的啦~ ( 比如不要有太多的错别字啦 (╯@_>@)╯ ┻━┻ )

建议之三 : 主线要有主线的存在感 ʃ ̂͜•̄ ̱̩ ̄͜►

不要把主线搞得像阿卡林一样没有存在感啦~

即使要插支线剧情也要以不同的形式让读者能轻易分辨,不要和主线混在一起,以及别太长。

建议之四 : 基本的排版 (・∀・)

文章分节的标题之类的可以帮助读者能够快速了解文章大体内容啦~


介于咱也不是什么写博客的菊苣,咱也就只能抛个砖引个玉.欢迎各位大触前来指教呗~


keyboard_arrow_left 上一篇文章: 浅说基于 Linux 内核的操作系统 (6) - 安装 Debian keyboard_arrow_right 下一篇文章: 权限的边界-关于社区的一些无关思考

然而评论的数量还没有评论框多😂

需要连接到国际互联网以使用 Disqus 评论哦~ 😂

v2mm 评论框由 https://v2mm.tech 提供 😂