JavaShuo
欄目
標籤
如何爲開發項目編寫規範的README文件
時間 2021-01-13
標籤
README
markdown
欄目
Markdown
简体版
原文
原文鏈接
完整的README包括什麼內容? 關於README的內容,這是我覺得是每個項目中都應該有的一個文件,目的是能簡要的描述該項目的信息,讓讀者快速瞭解這個項目。 一,它需要說以下幾個事項: 1 2 3 4 5 6 7 8 9 1,軟件定位,軟件的基本功能 2,運行代碼的方法:安裝環境,啓動命令等 3,簡要的使用說明 4,代碼目錄結構說明,更詳細點可以說明軟件的基本原理 5,常見問題
>>阅读原文<<
相關文章
1.
如何爲開發項目編寫規範的README文件(windows),此文詳解
2.
項目開發文檔編寫規範
3.
如何編寫開源項目的 README 文檔
4.
軟件開發文檔編寫規範
5.
README文檔的規範寫法
6.
項目開發文檔編寫規範【附文檔模板】
7.
項目編寫規範
8.
如何寫一個通用的README規範
9.
團隊項目開發"編碼規範"
10.
開發工具總結(9)之開源項目的README文檔的最全最規範寫法
更多相關文章...
•
Eclipse 編譯項目
-
Eclipse 教程
•
Maven 項目文檔
-
Maven教程
•
PHP開發工具
•
Docker容器實戰(七) - 容器眼光下的文件系統
相關標籤/搜索
PHP開發規範
readme
文件的讀寫
Java項目開發
規範
項目開源
開源項目
如何
何如
我的項目
Markdown
紅包項目實戰
PHP教程
Spring教程
開發工具
文件系統
插件
0
分享到微博
分享到微信
分享到QQ
每日一句
每一个你不满意的现在,都有一个你没有努力的曾经。
最新文章
1.
部署Hadoop(3.3.0)僞分佈式集羣
2.
從0開始搭建hadoop僞分佈式集羣(三:Zookeeper)
3.
centos7 vmware 搭建集羣
4.
jsp的page指令
5.
Sql Server 2008R2 安裝教程
6.
python:模塊導入import問題總結
7.
Java控制修飾符,子類與父類,組合重載覆蓋等問題
8.
(實測)Discuz修改論壇最後發表的帖子的鏈接爲靜態地址
9.
java參數傳遞時,究竟傳遞的是什麼
10.
Linux---文件查看(4)
本站公眾號
歡迎關注本站公眾號,獲取更多信息
相關文章
1.
如何爲開發項目編寫規範的README文件(windows),此文詳解
2.
項目開發文檔編寫規範
3.
如何編寫開源項目的 README 文檔
4.
軟件開發文檔編寫規範
5.
README文檔的規範寫法
6.
項目開發文檔編寫規範【附文檔模板】
7.
項目編寫規範
8.
如何寫一個通用的README規範
9.
團隊項目開發"編碼規範"
10.
開發工具總結(9)之開源項目的README文檔的最全最規範寫法
>>更多相關文章<<