1. README 規(guī)范

我們直接通過(guò)一個(gè) README 模板，來(lái)看一下 README 規(guī)范中的內(nèi)容：

# 項(xiàng)目名稱<!-- 寫一段簡(jiǎn)短的話描述項(xiàng)目 -->## 功能特性<!-- 描述該項(xiàng)目的核心功能點(diǎn) -->## 軟件架構(gòu)(可選)<!-- 可以描述下項(xiàng)目的架構(gòu) -->## 快速開(kāi)始### 依賴檢查<!-- 描述該項(xiàng)目的依賴，比如依賴的包、工具或者其他任何依賴項(xiàng) -->### 構(gòu)建<!-- 描述如何構(gòu)建該項(xiàng)目 -->### 運(yùn)行<!-- 描述如何運(yùn)行該項(xiàng)目 -->## 使用指南<!-- 描述如何使用該項(xiàng)目 -->## 如何貢獻(xiàn)<!-- 告訴其他開(kāi)發(fā)者如果給該項(xiàng)目貢獻(xiàn)源碼 -->## 社區(qū)(可選)<!-- 如果有需要可以介紹一些社區(qū)相關(guān)的內(nèi)容 -->## 關(guān)于作者<!-- 這里寫上項(xiàng)目作者 -->## 誰(shuí)在用(可選)<!-- 可以列出使用本項(xiàng)目的其他有影響力的項(xiàng)目，算是給項(xiàng)目打個(gè)廣告吧 -->## 許可證<!-- 這里鏈接上該項(xiàng)目的開(kāi)源許可證 -->

自動(dòng)生成 Readme 網(wǎng)頁(yè) https://readme.so/editor

2. 項(xiàng)目文檔規(guī)范

為了方便全球開(kāi)發(fā)者和用戶使用，開(kāi)發(fā)文檔和用戶文檔，可以預(yù)先規(guī)劃好英文和中文 2 個(gè)版本。為了加深你的理解，這里我們來(lái)看下實(shí)戰(zhàn)項(xiàng)目的文檔目錄結(jié)構(gòu)：

docs
├── devel                            # 開(kāi)發(fā)文檔，可以提前規(guī)劃好，英文版文檔和中文版文檔
│   ├── en-US/                       # 英文版文檔，可以根據(jù)需要組織文件結(jié)構(gòu)
│   └── zh-CN                        # 中文版文檔，可以根據(jù)需要組織文件結(jié)構(gòu)
│       └── development.md           # 開(kāi)發(fā)手冊(cè)，可以說(shuō)明如何編譯、構(gòu)建、運(yùn)行項(xiàng)目
├── guide                            # 用戶文檔
│   ├── en-US/                       # 英文版文檔，可以根據(jù)需要組織文件結(jié)構(gòu)
│   └── zh-CN                        # 中文版文檔，可以根據(jù)需要組織文件結(jié)構(gòu)
│       ├── api/                     # API文檔
│       ├── best-practice            # 最佳實(shí)踐，存放一些比較重要的實(shí)踐文章
│       │   └── authorization.md
│       ├── faq                      # 常見(jiàn)問(wèn)題
│       │   ├── iam-apiserver
│       │   └── installation
│       ├── installation             # 安裝文檔
│       │   └── installation.md
│       ├── introduction/            # 產(chǎn)品介紹文檔
│       ├── operation-guide          # 操作指南，里面可以根據(jù)RESTful資源再劃分為更細(xì)的子目錄，用來(lái)存放系統(tǒng)核心/全部功能的操作手冊(cè)
│       │   ├── policy.md
│       │   ├── secret.md
│       │   └── user.md
│       ├── quickstart               # 快速入門
│       │   └── quickstart.md
│       ├── README.md                # 用戶文檔入口文件
│       └── sdk                      # SDK文檔
│           └── golang.md
└── images                           # 圖片存放目錄└── 部署架構(gòu)v1.png

總結(jié)

以上是生活随笔為你收集整理的README 规范和项目文档规范的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。