一、為什麼要結構規範化
結構規範化當然為了整齊劃一，方便他人閱讀和自己閱讀。
二、規範化的目錄組織方式
一般情況下都是這種方式，（上圖摘自roygood 部落格）。
1. foo是我們的專案名稱
2. bin：下面存放專案的可執行檔案和指令碼
3.db（database的縮寫）: 用來儲存一些資料
4. docs : 一般也會命名為logs，用來存放日誌檔案，主要用於後面專案執行的排錯
5. setup.py: 安裝、部署、打包的指令碼
6. requirements.txt: 存放檔案所需要的外部包列表
7.readme: 專案說明檔案 （命名格式為.md，用markdown 編輯）
三、關於readme的內容
在githhub專案中最為常見，主要用於說明以下事項：
1. 軟體的功能
2. 軟體的執行環境，以及啟動方法
3.簡要的使用說明。
4.**目錄結構說明，更詳細點可以說明軟體的基本原理。
5.常見問題說明。
四、setup.py 檔案作用
一般來說，用setup.py來管理**的打包、安裝、部署問題。業界標準的寫法是用python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源專案中。不過這裡的核心思想不是用標準化的工具來解決這些問題，而是說，乙個專案一定要有乙個安裝部署工具，能快速便捷的在一台新機器上將環境裝好、**部署好和將程式執行起來。
setup.py可以將這些事情自動化起來，提高效率、減少出錯的概率。"複雜的東西自動化，能自動化的東西一定要自動化。"是乙個非常好的習慣。
五、requirements.txt檔案
這個檔案存在的目的是:
方便開發者維護軟體的包依賴。將開發過程中新增的包新增進這個列表中，避免在setup.py安裝依賴時漏掉軟體包。
方便讀者明確專案使用了哪些python包。
這個檔案的格式是每一行包含乙個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過pip install -r requirements.txt來把所有python包依賴都裝好了。
文章參考：
軟體專案程式設計規範
1.每個檔案級模組必須編寫乙個說明，模組說明要求以注釋的形式出現在模組的首部，要寫清楚該模組的功能，並寫明編寫人及編寫時間 為了以後系統整合時交流方便一些 2.對於每乙個函式都應給出函式說明，描述其函式功能 引數說明以及返回值說明，如果是修改別人的檔案，應寫明編寫人及修改時間 3.標頭檔案書寫規範 ...
軟體目錄結構規範
金角大王 為什麼要設計好目錄結構?設計專案目錄結構 就和 編碼風格 一樣，屬於個人風格問題。對於這種風格上的規範，一直都存在兩種態度 一類同學認為，這種個人風格問題 無關緊要 理由是能讓程式work就好，風格問題根本不是問題。另一類同學認為，規範化能更好的控制程式結構，讓程式具有更高的可讀性。我是比...
軟體目錄結構規範
專案目錄結構 是屬於 可讀性和可維護性 的範疇，我們設計乙個層次清晰的目錄結構，就是為了達到以下兩點 所以，保持乙個層次清晰的目錄結構是有必要的。更何況組織乙個良好的工程目錄，其實是一件很簡單的事兒。關於如何組織乙個較好的python工程目錄結構，已經有一些得到了共識的目錄結構。在stackover...