如何寫一個優秀的GitHub項目README文檔？
今天給大家介紹一個Github上的README文檔寫作教程模版，該模版目前獲得6634顆星星，2296Fork，相對而言，還是比較得到大家認可的。不花哨，不別出心裁，一個比較實用的，普適性的架子；所謂教科書式，不外如此。原文是英語，大神可直接看戳我查看。下面是我翻譯的中文版（未完全按照原文翻譯 ...
原文：如何寫一個通用的README規范
背景 我們平常在進行項目開發時，一般都會把代碼上傳至代碼托管平台上方便管理和維護。目前我廠使用的托管平台是SVN，國內外還有一些比較知名的代碼托管平台，比如github Gitlab BitBucket，碼雲和碼市等。 但我們在多人合作開發下，經常碰到的最頭疼的問題是，其他開發者在交接給我們一個項目時只是對項目目前現有的功能簡單的描述了下，我們在后續迭代功能時突然發現連最基本的項目如何運行都沒有 ...
2018-05-01 21:36 0 3806 推薦指數：
相關推薦
【github】論怎么去寫一個高大上的ReadMe
前言 以前我時常覺得，自己寫的ReadMe很單調乏味，但后來仔細研究一下后，發現有很多方式可以讓ReadMe在簡潔的基礎上變得好看些，所以在這里和大家分享，如果大家有更好的想法，也非常歡迎在評論區留言哦 美化方案 加彩色徽章：介紹npm版本，證書類型 ...
什么是接口文檔，如何寫接口，有什么規范？
一、什么是接口文檔？在項目開發中，web項目的前后端分離開發，APP開發，需要由前后端工程師共同定義接口，編寫接口文檔，之后大家都根據這個接口文檔進行開發，到項目結束前都要一直維護。 二、為什么要寫接口文檔？1、項目開發過程中前后端工程師有一個統一的文件進行溝通交流開發 ...
rasa 如何寫一個故事
設計故事 在設計故事時，需要考慮兩組對話交互：快樂路徑和不快樂路徑。快樂路徑描述用戶何時按照您的預期遵循對話流程，並在出現提示時始終提供必要的信息。然而，用戶經常會因為問題、閑聊或其他問題而偏離愉快 ...
matlab如何寫一個類
類是一種數據類型，與普通的數據類型不同的是類不僅包含數據，還包含對數據的操作，類把數據和數據操作方法封裝在一起，作為一個整體參與程序的運行。類具有可繼承性，創建一個新的類的時候，可以在一個基類中添加成員派生出新類。類的變量和類的實例是不同的，類的實例是動態分配的內存區域，通常稱類的實例維“對象 ...
如何寫一個簡單的shell
如何寫一個簡單的shell 看完《UNIX環境高級編程》后我就一直想寫一個簡單的shell來作為練習，因為有事斷斷續續的寫了好幾個月，如今寫了差不多來總結一下。 源代碼放在了Github: https://github.com/yibo141/Oh-Shell 簡單的分析 我們的shell ...
【Android】如何寫一個JsBridge
JsBridge 簡介 Android JsBridge 就是用來在 Android app的原生 java 代碼與 javascript 代碼中架設通信（調用）橋梁的輔助工具。 原文地址點這里 ...
如何寫一個jQuery插件
jQuery 插件開發模式 jQuery 的插件開發模式主要有三種： 通過$.extend()來擴展jQuery 通過$.fn向jQuery添加新的方法 通過$.widget()應用 ...