摘要

本文主要讲述一些平时写作过程中和查询资料时遇到的问题,整理出来并加上个人见解,供大家交流分享。


关于教程示例

1. 教学是否有价值?

一篇优秀的教学文章,不要求读者在阅读理解了文章内容后,能完完整整实现文中所述的整个内容,但至少能实现其中讲述的核心模块。否则这篇文章就没起到作用,不会的还是不会。


2. 读者是否能读懂?

如果有一些对学习阶段的读者不太友好的专有名字或生僻词汇,请至少给出一个说明或链接提示读者去查阅相关信息。文章言辞上应该尽量通俗易懂,内容上应该具有逻辑连贯性,尽可能给读者铺路,去引导他们,而不是给读者挖坑,去刁难他们。


3. 引用是否权威?

引用官方资源的文章,请在必要位置给出内容来源或者参考文献等,不仅是作为一项依据,提高内容来源的权威性和真实可靠性,也是给读者提供一个扩展学习的机会。


4. 文章是否严谨?

对于文中来自作者个人的内容,请确保其相对正确性,在作者自身都不确定代码是否能运行或者结论是否正确等情况下,请不要以肯定的语气写下,否则可能会对读者造成误导。


5. 隐患是否告知?

对于读者在按照教学一步一步实现的过程中,或者作者过去在实现的过程中,遇到的一些隐患问题和很难解决的bug,应该显式地在文中说明可能会出现的问题以及引导读者去解决问题,而不是让读者止步于此。


6. 是否有实例参考?

教学文章很忌讳通篇都是文字或大段大段的代码,那会让读者觉得枯燥无味,不利于学习。无论是代码段,还是贴图,甚至可以是gif图,演示视频,实时预览效果,在线demo等,都是有利于提高读者兴趣阅读文章的。


关于解决方案

1. 能否解决问题?

一篇解答类文章,应该针对某一个问题,或某一类有相同特征和相似解法的问题,起到对症下药的作用,如果是不同领域的问题,作者应该先自己实践,确定方法可行后,再讲述自己的解答过程,并加以讲解原理。

2. 描述是否有代表性?

对于标题包括问题日志的,如果信息很长,应该截取其中的关键语句,省略与问题无直接关系的提示语句,如果信息很短,应该保留完整信息,供读者对比参考。
对于摘要或者正文才描述问题日志的,请提供问题原始日志,可将敏感信息用符号替换,这样便于读者确定是否是他搜寻的问题。


3. 是否给出产生原因?

解答的文章,不仅应该解决问题,还应该分析总结为什么会出现这个问题,知其然并知其所以然,这样才可以避免下一次出现同样的问题,同时,能分析出产生原因,更能够帮助读者加深记忆,扩展知识面。


关于学习笔记

1. 分类是否清晰?

笔记类文章,应该明确细分属于哪一类知识点,记录关键词,这样便于将来自己回顾时快速理解,也利于读者明确相关知识体系。


关于版权

1. 是否属于转载?

对于转载的文章,应该在明显的地方注明文章来源以及原著链接等信息,尊重每一位作者的劳动果实和知识产权。


2. 是否有引用?

同转载,引用部分也应该说明引用自哪位作者的哪一个作品。


总结

坚持写博客是一个好习惯,但写出来的博客要优雅美观,而不是草草了事只图篇数。一篇优秀的博客,不仅是作者技术水平的体现,也是作者职业素养的侧映。

记录一些博客写作心得相关推荐

  1. CSDN博客写作编辑器如何使用?

    文章目录 0.引言 1.快捷键 2.文字 3.链接和代码 4.注脚和注释 5.公式 6.表 7.图 0.引言   笔者阅读CSDN博客已有五年,从最初的学习跟随者,到现在的CSDN博客创造者,这其中的 ...

  2. 0. 国内,首套,成体系,技术博客写作专栏发布啦

    橡皮擦,一个逗趣的互联网高级网虫,为你带来新职场故事,搬来程序员敲门砖. 作者嘚啵 der 这是一套技术博客写作专栏的概述篇 这篇文章从整体结构上告诉你,这个专栏要干啥 专栏的规划被群友念叨了半年,直 ...

  3. 【AI JUST AI】自然语言交互式学习,ChatGPT成了我的最佳博客写作助手

    [AI JUST AI]自然语言交互式学习,ChatGPT成了我的最佳博客写作助手 什么是自然语言交互式学习? ChatGPT是如何成为我的最佳博客写作助手的? **把与Chat GPT的每一次对话都 ...

  4. 博客写作技巧_35个管理和处理多作者博客的技巧

    邀请其他博客作者和作家成为合著者是扩展自己博客的一种好方法. 假设正在招聘作家,那么您可能面临的下一个大问题就是管理 . 管理一个博客的多个作者绝非易事. 保持共同作者的控制权,使他们按计划编写高质量 ...

  5. [原创]使用 NodeJS, MarkdownJS, PrettifyJS 打造个人博客写作平台 - 整体思路

    引言 最近博客更新比较频繁,尝试了几种不同的写作方式,总结如下: 第一种很简单了,直接使用博客园的在线编辑器. 优点是方便快捷,适合写些篇幅不大的随笔. 由于我经常更新的文章比较长,有时间需要花一两个 ...

  6. cometoj contest 6(记录型博客)

    前言 由于时间过少,这里仅仅记录我自己的思路(给自己看的),如果你有兴趣可以看看原题,再看看我写的,但是一般情况下不会很友好,此类文章在以后都会标记"(记录型博客)" A 我们发现 ...

  7. 为什么到最后还是要 专注于博客写作

    新手成长的路程为何这么艰辛.主要是因为知识结构的积累需要广博与专攻相结合.新手刚刚接触网络,基础薄弱导致很难成功.这个时候什么东西都学,什么东西都难学.快速使得自己的知识"博"起来 ...

  8. 12. 橡皮擦技术博客写作课,第一版收尾篇,写作也要懂点心理学

    欢迎来到橡皮擦的写作课 本文内容:那些博客中的写作心理学 心理学用在写作中 随着不断的写作,橡皮擦发现其实博客写作与产品设计有很多相似的地方,在写作的时候,你可以主动去设计一些"套路&quo ...

  9. MarsEdit for Mac(博客写作软件)

    MarsEdit 是Mac os平台上的一款博客写作软件,MarsEdit for mac这款软件支持离线管理几乎所有的blog,包括WordPress.Blogger.Movable Type等数十 ...

最新文章

  1. 因为 Java 和 Php 在获取客户端 cookie 方式不同引发的 bug
  2. C++中4种强制类型转换 ?
  3. ActiveMQ_安全配置(五)
  4. 廖雪峰Python教程-笔记
  5. matlab两个图共用一个x轴_SCI论文写作MATLAB出图(2)
  6. adam算法效果差原因_干货|快来get中央空调冬天制热效果差的十大原因!
  7. 远程计算机如何访问本地,远程计算机的本地Web服务访问(本地主机与IP地址)...
  8. android getpost代码
  9. Select2异步ajax方式加载数据
  10. ubuntu系统中的好用的键盘指法及打字练习软件
  11. 【江枫】lvm2与powerpath的Found duplicate PV问题
  12. 计算机二级考过律,计算机二级考试考完后的这些事情你知道吗?
  13. 华为云备份会上传私密相册吗_2 亿部华为手机背后,这个功能不能忽视
  14. 赠书赠券:《大话计算机》
  15. 什么是 PDF 扁平化?怎样扁平化 PDF? 一起涨知识!
  16. Android开发者指南
  17. 小米将推出新款自研芯片
  18. php字体大小_php设置字体的方法
  19. JavaScript学习(十八)--鼠标事件(鼠标点击松开移动效果)
  20. 详解+推导 神经网络中的前向传播和反向传播公式(神经网络中的梯度下降)

热门文章

  1. x轴z轴代表的方向图片_数控机床的X,Y,Z轴分别指什么方向的运动
  2. 数据结构---二叉树的顺序结构及实现
  3. from matplotlib import pyplot as plt 的基本用法
  4. 盛迈坤电商:提高产品吸引力的方法
  5. linux系统有8个小时时差
  6. 云顶之弈国际服服务器维护,【云顶之弈】国服和国际服有大量差异,国际服修复多个漏洞...
  7. 网络安全专业主要学什么?
  8. 【graceup系列】--基于Java带数字签名的邮件收发系统
  9. 干货 | 机器人中的“百达翡丽” — 五指精密仿生灵巧手技术浅析
  10. PyQt中文 eric6 汉化