1. README 規范

我們直接通過一個 README 模板，來看一下 README 規范中的內容：

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

自動生成 Readme 網頁 https://readme.so/editor

2. 項目文檔規范

為了方便全球開發者和用戶使用，開發文檔和用戶文檔，可以預先規劃好英文和中文 2 個版本。為了加深你的理解，這里我們來看下實戰項目的文檔目錄結構：

docs
├── devel                            # 開發文檔，可以提前規劃好，英文版文檔和中文版文檔
│   ├── en-US/                       # 英文版文檔，可以根據需要組織文件結構
│   └── zh-CN                        # 中文版文檔，可以根據需要組織文件結構
│       └── development.md           # 開發手冊，可以說明如何編譯、構建、運行項目
├── guide                            # 用戶文檔
│   ├── en-US/                       # 英文版文檔，可以根據需要組織文件結構
│   └── zh-CN                        # 中文版文檔，可以根據需要組織文件結構
│       ├── api/                     # API文檔
│       ├── best-practice            # 最佳實踐，存放一些比較重要的實踐文章
│       │   └── authorization.md
│       ├── faq                      # 常見問題
│       │   ├── iam-apiserver
│       │   └── installation
│       ├── installation             # 安裝文檔
│       │   └── installation.md
│       ├── introduction/            # 產品介紹文檔
│       ├── operation-guide          # 操作指南，里面可以根據RESTful資源再劃分為更細的子目錄，用來存放系統核心/全部功能的操作手冊
│       │   ├── policy.md
│       │   ├── secret.md
│       │   └── user.md
│       ├── quickstart               # 快速入門
│       │   └── quickstart.md
│       ├── README.md                # 用戶文檔入口文件
│       └── sdk                      # SDK文檔
│           └── golang.md
└── images                           # 圖片存放目錄└── 部署架構v1.png

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。