跳到主要内容

博客指南

Blogs Banner

为了确保所有 ZAP-Hosting 博客文章在质量和风格上的一致性，我们制定了一系列指南，供你在参与我们的博客投稿计划时参考。你必须严格遵守这些指南，以确保你的建议和后续草稿能被快速处理。更重要的是，这将保证我们的读者在阅读博客时获得更好、更统一的高质量体验。

我们的博客投稿指南主要分为以下几个部分：

  • 结构
  • 风格
  • 格式
  • 术语

结构​

我们博客投稿计划中的文章应遵循相对统一的结构，激发读者兴趣并为读者提供信息和新闻。ZAP 投稿团队会与你合作，确保你的结构在创建博客建议时合适。

  • 页面标题 (H1)
  • 引言 (H2)
  • 准备工作 (H2)
  • 主题内容 (H2)
  • 可选：子主题 1 (H3)
  • 可选：子主题 2 (H3)
  • ...
  • 可选：其他主题 (H2)
  • 结论 (H2)
子标题的使用（H3 & H4）

鼓励你使用 H3 标题在主要的 H2 章节内创建子章节，将较大的内容块进一步组织成有条理的部分。上文的 主题内容 部分就是一个示例。

如果你使用子标题，通常建议在父标题下至少有两个或更多子标题，否则只有一个子标题通常没有意义。

信息

请记住，上述结构仅为大致参考。博客正文的标题可能根据内容需要有所不同，但所有博客文章应始终包含标题、引言和结论，围绕正文内容展开。

标题​

博客文章的标题应简短、清晰且吸引眼球，明确说明文章主题，比如是新闻还是技巧建议。一个好的标题示例是：Top 10 FiveM Police Scripts。

引言​

博客引言应简洁明了，通常为1-2句。内容应简要描述当前主题，最重要的是告诉读者这篇博客将呈现什么内容，告知最终目标。

关于 SteamCMD 的博客引言示例：

  • 第一句：SteamCMD 是安装多款游戏专用服务器（如 Palworld、Enshrouded 等）必备的重要工具。
  • 第二句：本文将介绍如何首次在 Linux 服务器上安装 SteamCMD，示例中使用 Ubuntu，但其他发行版的流程也大同小异。

如示例所示，引言简要总结了博客相关主题，并向读者展示了整体目标。

准备工作​

准备工作部分用于说明读者在跟随博客之前必须满足的前置条件，可能是软件或硬件需求，配置防火墙等软件，或指导用户通过 SSH 或 RDP 登录服务器。

强烈建议浏览我们的 ZAP-Docs 网站，查找可能涵盖或相关的准备步骤的指南。如果已有相关指南（例如 SSH 初始访问），应链接该指南并提醒读者先完成再继续。

常见的博客前置条件包括：

  • 所需软件（如 Git、Node.js、Python、Docker）
  • 帮助读者掌握基础知识的教程（如其他 ZAP-Docs 页面）
  • 用户账户，如 API
  • 必要设置（如 DNS/SSL）

反向代理博客的示例：

要设置反向代理，你需要一台 Linux 服务器来托管代理服务器，并且应能连接到它。如果需要帮助，请参考我们的 [SSH 初始访问](vserver-linux-ssh.md) 指南。你还需要拥有一个域名。对于每个计划使用的子域，应创建一个指向 Linux 服务器 IP 地址的 `A` 记录。

主题内容​

现在是撰写博客主体内容的时候了。建议将文章分成几个部分，帮助读者保持兴趣。没有严格的分割要求，但一般来说，应将大量内容拆分成几个标题。ZAP 投稿团队会在整个过程中协助你。

如果博客提供步骤式教程，建议在主题标题中包含步骤编号和简短描述，例如 步骤 1 - 创建文件夹。第一句应简要说明该步骤的目标。步骤间应有简短的引入和过渡语句，告知读者已完成的内容和接下来要做的事情，这些过渡语句为读者提供重要上下文。避免重复，使用多样表达。

结论​

最后是博客的结论部分。用1-3句总结，说明读者成功完成了什么、学到了什么，或为信息性指南做总结。

也建议提供进一步阅读的参考链接，指向其他博客或指南，帮助用户扩展相关知识。应链接任何现有的 ZAP-Docs 指南或博客，尤其是与本指南自然衔接的内容。

风格​

ZAP-Hosting 文档的写作风格秉持高质量、实用且易于理解的原则，支持广泛主题，适合各种经验水平的读者。

技术性 & 准确性​

我们的博客力求技术准确、紧跟行业最新信息。每篇博客都应为读者提供高质量、写得好的新技术和主题信息，以及注重读者学习的教程。如果博客包含步骤式教程，每一步都应有明确目的和解释，必要时提供额外选项或参数。

作者应始终校对并测试博客内容，确保技术正确且功能正常后再提交草稿。ZAP 投稿团队会在适当时阅读并测试你的博客，确保内容一致且事实准确，或提出改进建议。

提示

我们强烈建议作者在提交草稿前使用拼写检查工具，确保拼写和语法无误。推荐网站：https://languagetool.org/

实用 & 有用​

读者读完博客后，应能学到知识、搭建或完成某项任务。我们的博客支持各种经验水平的读者，因此内容应全面覆盖主题，确保读者获得知识或达成目标。作为作者，你必须详尽讲解主题，包括必要的前置条件。只有当 ZAP Docs 没有相关文档，或读者需要额外非必需但有益的知识时，才可引导读者访问外部网站。外部链接不得指向竞争对手文档。

友好、正式 & 全面​

我们期望文档具有前瞻性和亲和力，便于所有读者理解，同时保持正式。博客写作应采用适合所有读者的语气，无论经验或语言背景如何。

由于博客主要支持读者学习并达成目标，建议使用第二人称（如“你需要…”），而非第一人称（如“我认为…”），以保持读者参与感和关注点。

最后，所有作者必须遵守我们的行为准则，确保博客内容对任何年龄、种族、性别认同、经验水平、国籍、宗教、政治立场、性取向、社会经济地位或技术选择的读者都友好。避免任何可能冒犯的语言及涉及上述敏感话题的内容。

格式​

我们的博客采用广泛使用的 Markdown 标记语言格式。以下部分介绍我们使用的元素及其用法。

你可以使用任何写作工具创作内容，但我们强烈推荐使用 StackEdit，它支持 Markdown 的所有强大功能。你可以直接导出到 Google Drive 或其他文件分享应用，并生成链接分享给我们。

提示

想了解更多 Markdown 功能示例和详细说明，请访问 Markdown Guide。

标题​

标题是分隔博客内容的重要格式选项。主标题使用 H1。

博客中，H2 用于划分主要章节，H3 用于将主章节细分为子章节。例如，将主章节拆分为多个步骤，方便读者跟进。H4 较少用，但也用于进一步细分。

信息

如果使用子标题（如 H3 在 H2 下），请确保该层级内有两个或以上同级标题，否则用法不当。

标题使用示例：

## 安装
H2 - 主章节

### 下载游戏文件
H3 - H2 的子章节

#### 通过 SteamCMD
H4 - H3 的子章节

#### 通过 GitHub 手动下载
H4 - H3 的子章节

### 配置准备
H3 - H2 的子章节

### 启动服务器
H3 - H2 的子章节

行内 Markdown​

我们使用多种行内格式提升博客可读性，适合不同技术水平的读者。以下介绍各格式用法。

加粗文本​

加粗主要用于强调信息，如：

  • 步骤间的上下文切换
  • 主机名、凭证和用户名
  • 关键术语

用双星号包裹文本实现加粗，例如 **hello there** 显示为 hello there。

斜体​

斜体主要用于引入新的技术关键词，例如，我们今天将设置一个 反向代理。

用单星号包裹文本实现斜体，例如 *ZAP-Hosting - More POWER!* 显示为 ZAP-Hosting - More Power!。

行内代码​

行内代码格式主要用于展示技术信息，如 URL。常见示例：

  • 文件名和路径（如 C:/User/[YourName]/AppData....test.png）
  • URL（如 https://zap-hosting.com）
  • 端口（如 :30120）
  • 命令（如 ipconfig）
  • SQL 查询（如 SELECT * FROM servers）
  • 快捷键（如 ENTER 或 CTRL + C）

表格​

表格适合展示大量重复信息，比如游戏内命令、描述和用法。示例：

| 命令       | 描述                   | 用法                  |
| ---------- | ---------------------- | --------------------- |
| /help      | 发送帮助命令           | /help [category]      |
| /stop      | 停止服务器             | /stop [true/false]    |

代码块​

代码块适合展示命令、脚本、终端输出等内容。

用三个反引号包裹文本创建代码块。可在第一个反引号后指定语言，自动高亮。例如，JavaScript 代码块：

function hello(name) {
    console.log(name)
}

var server = "ZAP-Hosting"
hello(server)

截图​

截图是引导读者视觉跟随步骤的极佳方式，强烈推荐在合适时使用。

添加截图语法如下，替换 your_url 为图片链接：

![](your_url)

最佳实践是使用在线图床，如 Imgur，上传图片并在 Markdown 中使用链接。

术语​

博客中会使用大量关键术语。我们要求统一使用美式英语拼写，确保所有博客内容一致。以下是一些常用术语的标准化说明。

ZAP-Hosting 产品​

提及 ZAP-Hosting 产品时，务必使用正确的名称、拼写和大小写。可访问 ZAP-Hosting 官网 查看相关产品页面确认。

用户自定义属性​

部分博客中，配置项如用户、主机名、域名、IP 地址和 URL 需读者替换为自己的信息。

默认应使用 [your_attribute] 格式区分静态和唯一元素，其中 [attribute] 替换为属性类型。例如，提及 IP 时写 [your_server_ip]，提及 URL 时写 http://[your_server_ip]:30120。首次出现时应说明哪些属性需替换，确保读者理解。

默认主机名、用户名或数据库名使用 zaphosting。

软件​

提及软件时，确保名称拼写和大小写正确。如果软件官网大小写不统一，文章内保持一致即可。

首次提及软件时应链接至其官网（如有官方站点）。

编辑此页
最后由 Florian Galz 于 更新
Cookie 设置