博客站长要养成阅读ReadMe的好习惯

投稿   明月登楼  2019-01-04 07:20:41  121 人阅读  32 条评论

不知道从什么时候开始,明月发现很多站长们在使用插件、代码、扩展、应用的时候完全忽略了 ReadMe 的阅读必要性,基本上都是出了问题就到处张嘴就问,评论里、QQ 里、Telegram 群组里这样的人几乎每天都可以看到。问的问题其实大部分都已经在 ReadMe 文档里了,可就是没有人想到去看看这个 ReadMe 文档,不得不说,这种奇葩的思维模式让明月很是反感。今天,明月就给大家讲讲阅读  ReadMe 好习惯养成的重要性。下面先给大家脑补一下什么是 ReadMe ?

博客站长要养成阅读ReadMe的好习惯 海纳百川 第1张

何为 ReadMe?

读我档案(英文:Readme),又称“自述文件”,是随着软件发布的一种说明文件,里面通常包含有软件的描述或使用的注意事项。这种档案通常是纯文字文件,被命名为 README.TXT、README.1ST 或 READ.ME 等等,但也有 RTF、DOC 或 Markdown 格式的读我档案。档名通常是以大写英文字母组成,这是因为大写字母比小写字母有着较小的 ASCII 码,因此在一些以 ASCII 顺序来排序档案名称的操作系统里,它会被列在档案列表的第一个。即使这些人没有关于读我档案的知识,这种档案的特殊命名方式也能够使任何人迅速发现。

摘录自『维基百科

经常使用或者浏览 GitHub 的站长们如果细心一点就会发现 GitHub 上的项目都默认会有一个 README.md 文件,并且访问 GitHub 项目链接的时候首页几乎都是清一色的显示 README.md 文档。这就很能说明 ReadMe 文档的重要意义了,毕竟 GitHub 作为全球第一的源代码托管服务网站,汇集的都是全球的开发编程人员。既然 GitHub 这么强调和重视 ReadMe 文档可想而知这个 ReadMe 文档其实就是代码的灵魂描述,毕竟不是所有人都可以对源代码像自然语言那样进行阅读和理解的。所以我们也可以理解为 ReadMe 文档其实就是代码或者插件、脚本等等的说明文档,也可以理解为是一种“使用说明”也不为过。

对于我们站长来说无论是插件代码、主题代码、脚本代码等等,在 ReadMe 文档里都会有基本使用、安装说明以及常见问题汇总的。代码编写者既然分享出来了,当然是为了让大家使用的,自然会在 ReadMe 文档认真的总结和书写必要的信息给使用者的,所以 ReadMe 文档有时候就是“官方使用说明”的另一种存在形式

博客站长要养成阅读ReadMe的好习惯 海纳百川 第2张

所以,明月强烈建议大家在获取到一个插件、主题、代码、脚本等等别人开发的东西的时候,要找找里面的 ReadMe 文档或者类似的 TXT 文件等等阅读一下。有中文的当然最好了,没有中文的也不要紧,毕竟现在的在线翻译能力已经非常的逆天了,在其帮助下基本的意思和思路还是可以理解的,当然如果你的语文是体育老师教的除外!

在阅读了相关的 ReadMe 文档后还是搞不定的时候,你再去提问和网上搜索查询时就会发现你的提问更加的精准了,找到答案和解决办法的速度也就快了很多,否则一无所知的情况下问问题只能突显你的“弱智”和“小白特质”而已。

其实,阅读 ReadMe 文档并不一定就可以熟练的使用了,但是可以通过阅读 ReadMe 文档了解这个代码或者插件、脚本的开发思路、功能特性、运行原理,什么事儿了解了原理使用上手其实也就不是个事儿了都。有人会说有时候根本就找不到 ReadMe 文档怎么办呢?答案很简单,明月将这类代码、插件、脚本归类为“来历不明”,请慎重考虑选择和使用。

历史上的今天:

如果文章对你有帮助,请赞赏支持作者继续创作!

文章标签:
原文地址:https://www.imydl.com/work/9642.html
温馨提示:文章内容仅代表作者个人观点,不代表boke112导航赞同其观点和对其真实性负责!
版权声明:本文为投稿文章,感谢 明月登楼 的投稿,版权归原作者所有,欢迎分享本文,转载请保留出处!
明月登楼

相关文章 分类热门分类热评最新问答

 发表评论

中国赞表情摊手表情吃瓜表情笑哭表情偷笑表情衰表情汗表情思考表情费解表情抓狂表情晕表情流泪表情疑问表情嘻嘻表情吃惊表情鼓掌表情

  1. 杰新博客
    杰新博客 @回复

    readme是一个项目的说明文档,你实现了再牛的功能总要让人知道是什么吧,光看代码需要使用很长时间去彻底了解代码,这样是没有意义的。 [摊手]

  2. 唯心寒辞
    唯心寒辞 @回复

    使用之前都是习惯看看ReadMe。

  3. 子午书屋
    子午书屋 @回复

    写代码的人,应该要要成编写readme的习惯

  4. 靠谱学生兼职网
    靠谱学生兼职网 @回复

    好习惯贵在坚持

  5. 神器
    神器 @回复

    readme 确实减少了不少重复劳动 可惜被无视太多次了

  6. 清风小墨
    清风小墨 @回复

    有些人不会markdown所以不想读

  7. 洁灰博客园
    洁灰博客园 @回复

    我能说看到很多字会觉得内心搅热吗?看到代码又不会,,,额呵呵

  8. 弥雅尔尔
    弥雅尔尔 @回复

    弥雅会看的,但是可惜弥雅不是技术出生,所以看 了意义也不是很大!

  9. Jane博客
    Jane博客 @回复

    确实没有这样的好习惯!

    • 明月登楼
      明月登楼 作者回复2019-01-04 14:17  回复

      @Jane博客没有阅读使用说明书的习惯,就不能算是学习积累了,形成不了自己的东西!

  10. 抖友网
    抖友网 @回复

    没这个习惯, [偷笑]

  11. 明月清风
    明月清风 @回复

    感谢分享,不过以前知道这个东西里面有解释,但是没看过这样子的介绍。

  12. nice
    nice @回复

    我看过很多里面都是 发布该资源的网站的介绍 [笑哭]

    • 明月登楼
      明月登楼 作者回复2019-01-04 14:16  回复

      @nice如果是这样的插件、代码、主题的话,就不要用了!绝对的不干净!

  13. Quanyin
    Quanyin @回复

    伸手党太多,抱着我安装一定成功,从不看文档,出现问题了就到处找人问,还是一种你肯定会,必须告诉我的态度。。

  14. 猫鼬
    猫鼬 @回复

    使用说明书!? [笑哭]

    • 明月登楼
      明月登楼 作者回复2019-01-04 14:19  回复

      @猫鼬只要是正规的代码或者插件之类,一定会有对应的使用文档的!

  15. 魏义齐博客
    魏义齐博客 @回复

    这个必须要阅读的,很多二开的开源程序如果不读这个贸然使用你可能会被“坑”

  16. 微信群赚钱
    微信群赚钱 @回复

    从来没读过,又是沙发