Sample Guide

如何写第一篇部署攻略

这一页演示的是“真正拿来发文章”的样子。你可以沿用这个结构,后面把主题换成 Nginx、Docker、VPS、前端部署、故障排查都可以。

分类:部署 更新时间:2026-07-07 阅读:5 分钟

目标

一篇好的攻略文章,最重要的是让读者快速知道“这篇能不能解决我的问题”。所以开头建议直接写目标、环境和结果,而不是先铺陈背景。

这篇示例适合什么内容

环境搭建、部署记录、命令速查、问题排障、方案比较和工具清单。

目录结构

你后面每多写一篇文章,只需要继续新建一个目录,并把这一篇相关的资源都放进去。

pages/
└── docker-deploy/
    ├── index.html
    ├── images/
    ├── audio/
    └── video/

写作流程

  1. 复制 `pages/article-template/` 为新的文章目录。
  2. 先改标题、摘要,再写正文。
  3. 有命令就放代码块,有截图就放当前目录下的 `images/`。
  4. 如果文章引用官方资料,把链接单独放一节。
小建议

攻略文章最有价值的部分,通常是“为什么这样做”和“失败时怎么排查”。这两块可以多写一点。

代码示例

下面这个例子就是一个很常见的“新建文章”流程:

cp -R pages/article-template pages/docker-deploy-guide

# 编辑 pages/docker-deploy-guide/index.html
# 然后去 index.html 增加文章入口

如果你文章里要放配置文件,也可以直接这样展示:

server {
  listen 80;
  server_name example.com;

  location / {
    root /var/www/site;
    index index.html;
  }
}

媒体内容

wiki 风格页面示意图
你可以放截图、流程图、架构图或者命令执行结果对比图。

音频区

适合讲解录音、访谈片段或播客补充。

视频区

适合录屏演示、安装过程或效果展示。

链接规范

  • 官方文档优先: HTML 文档
  • 如果是第三方教程,建议顺手写一句为什么值得看。
  • 链接很多时,按“官方 / 社区 / 工具”分组更清楚。