功能詳細說明 專案說明文件編寫規範

markdown 的使用可以按需要參考：

規範1：使用 markdown 編寫說明文件

為了更好的利用 git 管理專案，一定要使用 markdown 來編寫專案說明文件，而不是使用.docx等格式的檔案編寫專案說明文件（git 無法管理細節）。不要使用.txt用來管理專案說明文件，它的功能太單一，同時可能會引入一些編碼錯誤問題，而相對的 markdown 功能可以滿足大多數專案開發的需求，支援，**，以及音訊的插入，並且也可以匯入流程圖。markdown 的語法並不複雜，很容易上手，支援將其轉換為pdf、docx等格式文件。markdown 可以直接作為幻燈片進行展示。

規範2：按照目錄樹編寫說明文件

為了更好地模組化管理專案，不推薦僅僅使用乙個目錄用來存放專案，應該將專案按照模組或者功能分割為不同目錄。這些目錄形成了具有等級的目錄樹，為了專案的清晰，最好在每個目錄下均存放乙個readme.md檔案用來記錄該目錄的功能與修改記錄（重大修改）。

規範3：單個readme.md檔案的編寫規範

在文件中簡略介紹該目錄做了什麼（what），為什麼這樣做（why），怎麼做的（how）。

在專案根目錄的readme.md需要交代涉及版權問題的一些內容。

引入hotfix.md，並將重大修改編寫進readme.md。

規範4：hotfix.md檔案的編寫規範

專案並不是一天建成的，需要在hotfix.md檔案中記錄專案開發過程**現的問題與解決策略。下面是乙個例子：

# teacher helper 版本更新記錄

摳圖輔助軟體工具：teacher helper
## v0.2
1. 修復 v0.1 版本的中文路徑輸出顯示亂碼問題。（v0.2.1@xinet:2019/7/26）
2. 修復 **部分邏輯問題。（v0.2.2@xinet:2019/7/27）
## v1.0（v1.0.1@xinet:2019/8/5）
- 將 `檢查` 按鈕改為 `審查`，輸出的 `errors.txt` 更名為 `checkout.txt`；
- 重構了**的邏輯，提高**的容錯能力；
- 增加對 負樣本 的搜尋功能。

小 tips：

如果你要檢視檔案的每個部分是誰修改的，那麼git blame就是不二選擇. 只要執行git blame [filename]，你就會得到整個檔案的每一行的詳細修改資訊：包括 sha 串，日期和作者。

$ git blame -l 160,+10 sha1_file.c

git的詳細說明文件

git status 檢視更改的檔案 git diff 檢視更改檔案細節 git reflog 檢視所有的提交記錄 比較兩個分支然後打成補丁 git diff 分支1 分支2 補丁名稱 commit回滾到上一次操作 git reset soft head 撤銷某一次提交 git revert git...

Mantis安裝說明文件

在錯誤追蹤系統中，mantis絕對是個輕量級的工具，無論安裝還是配置或使用，正如它自己的目標中所宣稱的。但是，對乙個中小型的專案來言，功能夠用。mantis是乙個基於php mysql web的開源的錯誤追蹤系統，以下安裝教程假設系統已經安裝好了apache php mysql的執行系統，如何安裝這...

Vue 基礎說明文件

vue是乙個mvvm框架,model view viewmodel 例項出的物件 el 檢視模型,頁面節點 data 所使用的變數,或者初始值 裡面通常放屬性 methods dom渲染完執行,通常是放view中需要響應的函式 解析資料 變數,函式,表示式 一 指令 1,v html v text ...