### 部署手冊要求 - 包含業務基礎 - 功能介紹 - 基本部署手冊 - 包含模擬案例 - 按照部署手冊要求 ### 文檔基本原則 - #### 面向初級運維人員編寫文檔，禁止面向0基礎（系統運維0基礎） - #### 禁止突出顯示（標紅、加粗）重要提示（不認真看文檔，活該踩坑） - #### 禁止過多描述基礎（沒基礎補充一下再看） - #### 引用他人文章要在文檔開始 **加粗注明（使用####）**作者和引用地址 `例： ####?[原文地址](http://www.cnblogs.com/reblue520/p/6874925.html?"原文地址")，非常感謝鄭子明的分享。` - #### 配置文件、報錯及日志，統一放置在文檔結尾或單獨建立一章節，保持文檔簡潔 - #### 文檔上傳前必須脫敏（密碼替換、主機名替換、實例名替換），避免不必要的麻煩 #### 基本介紹要求 1. 功能介紹或官方文檔鏈接 2. 適用場景 3. 基本部署 #### 部署手冊要求 1. 環境介紹（主機名、IP、配置、端口作用、拓撲圖），表格呈現 2. 如果表格內容較多，可拆分為兩個表格 3. 配置文件和注釋 4. 根據不同場景部署 #### 命令執行要求 ```shell 用``` ```包含 命令注釋用#開頭 ``` 舉例 ```shell #進入/opt目錄，解壓后移至/usr/local/下 cd /opt tar xzf Mycat-server-1.6-RELEASE-20161028204710-linux.tar.gz mv mycat /usr/local/ ``` #### 文檔目錄層級 ```shell 一、 1.1 1.1.1 1. ``` 舉例 ```shell 三、MySQL運維筆記 1.1 MySQL高可用 1.1.1 MyCAT 1. MyCAT基礎 ``` #### 筆記層級(markdown) ```shell ### 第一層級（功能介紹、業務部署、原理機制） #### 第二層級（應用場景、主要特性、優缺點） ##### 第三層級（主要步驟、原理分類、場景分類） ``` 舉例： ```shell ### Zookeeper服務部署 #### 偽集群方式部署 ##### 依賴環境部署 ##### Zookeeper部署 ##### 配置文件調整 ##### 服務器啟動 ``` ###