zoukankan      html  css  js  c++  java
  • 一篇技术文章合格的标准


    前言


    作为一个开发人员。常常须要在网上查找各种资料。可是一个让人倍受打击的事实是,如今网上的大多数文章质量都太糟糕。

    行文混乱,观点不清,结构失调,甚至有些都不能算是一篇真正的文章。

    作为一个有正确价值观的人,我觉得应该自己建立一个博客,写一些质量相对较高的文章(当然是自觉得)来提升国内互联网内容的质量。理所当然。不论什么人都有对这些文章中观点怀疑和评论的权利,我也非常愿意针对自己觉得有意义的评论进行讨论。

    笔者觉得一篇合格的文章应该遵循下面原则。

    非转载


    没有不论什么改动,直接粘贴复制别人的文章到自己的博客。这样的行为唯一产生的意义就是浪费了互联网上大量的硬盘空间。

    这样的东西(是的。它们不能称之为文章)没有不论什么新的知识和观点,不会对互联网做出丝毫建设性的贡献。

    有些人会说,我将这些文章放到我的博客。能够记录自己的学习轨迹。对自己是一个激励。而且我能够随时參考这些文章。假设是这样,那么你应该认识到一点。绝大多数的站点都有收藏功能,即便没有,你也能够非常easy的找到类似pocket的网络资源收藏工具。

    依据非转载原则。笔者觉得,csdn博客撰写页面上的那个原创和转载选项是一个充满负能量、毫无正面意义的垃圾功能。

    网络上的不论什么资源都应该是原创的。

    结构完整


    不论什么一篇文章都应该拥有完整的结构。

    诗、词作为文学作品中最精简的体裁。也会包含起、承、转、合的简约架构。体量比诗词更大的文章(普通技术文章、散文、杂文、论文)更须要良好的结构来支撑。没有一个说的过去的结构。文章就非常难站起来,就是一盘散沙,没有精神。这种文章看起来没有不论什么节奏,对读者来说是一种耐心的挑战。

    一篇文章的结构最低的要求是完整。尤其是技术文章,结构并不要求静止。可是必须是完整的。你能够写地具体也能够写地笼统,可是不能写的不完整。

    观点或主题


    观点是写文章的动机,一篇文章不可能没有观点就直接写出来。

    对于技术文章来说。观点可能就是一个详细的知识点。可是。一旦主题确定。文章中不论什么内容都必须为主题服务。

    避免不必要的、和主题无关的内容出如今文章中是明智的选择。而且,文章中的全部段落都应该为主题进行合理的安排。


    案例


    对于说明观点来说。举例是非常好的方式,好的文章应该尽量包括合理、贴切的案例。

    记得早些时候看过钱钟书先生的一些文章,比方《围城》《写在人生的边上》,文章中的比喻用的恰到优点。为观点进行了简单、巧妙的诠释。

    甚至连“写在人生的边”上这个标题都是一个绝妙的比拟。

    当然,比喻是最简单的案例。

    对于技术文章来说,有时候,一个简洁恰当的案例,要比大篇幅的解释还要更加深入人心和更easy使人理解。


    參考


    写文章之前多參考一些资料,是一个好的习惯。

    假设文章写完。末尾没有參考资料或者资源引用的链接,那要么是你版权意识不够,要么是你没有意识到參考资源对读者的作用有多大。当然。另一个最不应该的可能,就是你根本就没有參考其它资源。对于同一个观点,不同的人有不同的思考角度和思维方式。辩证和批判性思维是全面、深入理解一个问题有利的工具。


    排版


    排版是开发人员必备的基础能力之中的一个。

    没有基础的排版能力,是无法写出阅读性良好的文档的。文档算是最简单的文章。连文档的排版都不会,那么请自学word排版知识。再来写文章。

    一个版面杂乱的文章是会倒读者胃口的。

  • 相关阅读:
    svn 相关
    Xcode 升级到7.2版本出现崩溃想象
    IOS UILabel用UITapGestureRecognizer实现点击事件
    JSon解析
    IOS StoryBoard下的视图跳转
    Http中的get和post的区别
    swift-delegate(代理)或者block传值
    swift-自定义TabBar工具栏
    利用POPAnimatableProperty属性来实现动画倒计时
    NSLayoutConstraints加动画来改变约束
  • 原文地址:https://www.cnblogs.com/blfbuaa/p/7090603.html
Copyright © 2011-2022 走看看