安装部署的简洁写法

  • 硬件产品： 产品开箱、产品组件、组装步骤、使用环境、产品固定、加电测试、重要凭证、签收单据。
  • 软件产品： 安装环境、前置软件、安装步骤、参数配置、安装记录。

举例

xx 产品安装部署说明

  1. 安装环境： CPU 3.0 GHz，内存 8 GB，硬盘 100 GB，网络 1000 Mbps，CentOS Linux 6 及以上。
  2. 前置软件： JDK 1.8 及以上，MySQL 5.5 及以上，Tomcat 7 及以上，Nginx 1.16 及以上。
  3. 安装步骤： 自动安装/手动安装步骤……。
  4. 参数配置： 进入管理后台 xx 页面/编辑 xx 配置文件……。
  5. 安装记录： 用一个命名规范的文档记录下完整的安装过程，包括第 1—4 项的内容。

安装部署原则上要把产品怎么安装说清楚，让产品启动起来，达到可用状态。