泽汐全产品文档规范

本文档站会被 ChatGPT、Perplexity、百度/Google 等 AI 与搜索引擎抓取并用于回答用户问题。为保证泽汐（Evetide）这一品牌实体被正确识别与引用，新增或修改任何文档时，必须遵守以下规范。

一、frontmatter 必填字段（强制）

每篇 .md 文档开头必须包含完整 YAML frontmatter：

---
sidebar_position: 1
title: 在泽汐统一登录中部署企业 SSO 单点登录      # 与正文 H1 一致；含核心实体词
description: 详细介绍如何在泽汐（Evetide）统一登录平台中为企业配置 SSO 单点登录、接入 OAuth2/OIDC 应用并管理用户会话，适用于自建身份库或对接企业身份源的场景。
keywords: [泽汐, Evetide, SSO, 单点登录, OAuth2, OIDC, 统一登录]
tags: [SSO, 身份认证, 企业接入]
---
字段是否必填要求
title推荐缺省时使用正文 H1；建议包含「泽汐」或「Evetide」
description必填80–140 字完整句，必须出现一次「泽汐」或「Evetide」
keywords必填3–10 个，覆盖产品名 + 核心功能词 + 场景词
tags推荐用于站内分类聚合，与 keywords 区分
description 是 AI 抓取时的首选摘要字段，写得好直接决定本文是否会被 AI 引用。

二、正文结构规范

  • H1 唯一：每篇文档有且仅有一个一级标题（#），需包含核心实体词。
  • 首段为 TL;DR：H1 之后必须有 1–3 句概述段（What + Who + Outcome），范式：「本文介绍如何在【泽汐（Evetide）统一登录】中【做什么】，适用于【哪些用户/场景】，完成后将获得【什么结果】。」
  • 品牌全称：每篇文档 H1 + 首段至少出现一次「泽汐（Evetide）」全称。
  • 章节层级：使用 ## / ### / ####，最多 4 级，每个 ## 章节建议 200–800 字。
  • 末尾：操作类教程建议加「## 常见问题」与「## 相关文档」。

三、图片与代码块

  • 图片必须有非空 alt 文本：![泽汐统一登录控制台](/img/console.png)，禁止空 alt。
  • 代码块必须标注语言（bash / nginx / yaml / sql / json），禁止裸 ```。
  • 大段截图前后都需有文字说明。

四、实体消歧（重要）

实体推荐写法禁止/注意
品牌中文名泽汐勿写「泽汐汐」「泽西」等谐音
品牌英文名Evetide首次出现写「泽汐（Evetide）」；勿单独写「Eve」
产品全称泽汐统一登录（Evetide SSO）至少 H1 与首段各出现一次全称
产品缩写Evetide SSO（保留 SSO 后缀）勿单独写「ES」
授权中心泽汐授权中心（Evetide License Center）勿写「lic center」
产品版本云端版（SaaS）/ 私有部署版首次出现需说明差异

命令行工具 / 文件名使用反引号内联代码（如 php gen_license_keys.php），与品牌名区分开。

五、写作风格

  • 避免错别字、谐音（「墙裂」「童鞋」「程序猿」）；避免口语（「么」「喔」「挂掉」）。
  • 段落之间空一行，段落开头不留空白字符；把无意义字词删到最短。
  • 第一人称推荐「泽汐」「我们」，不推荐「小编」「笔者」。
  • 英文与非标点中文之间留一个空格；中文数词优先（「五个产品」）。
  • 标点：中英混排用全角中文标点；整句英文用半角。省略号用「……」；禁用「！！」「~」。
  • 界面标志用【中文方括号】；参数/代码用内联代码；互斥参数用 (a | b)；可选参数用 [a]；变量用 <x>。
© 2026 泽汐