风格指南

文本由 Phrase Language AI 从英语机器翻译而得。

风格指南是集中式的语言准则，定义了应如何为特定语言或区域设置编写内容。它们有助于确保语气、术语、格式和输出在各个项目和团队中保持一致。

风格指南以 Markdown (.md) 文件形式上传，并存储在共享库中，可通过在左侧导航菜单中选择资产从 Phrase 平台仪表板访问。它们可以在以下项目中附加和重复使用：

Phrase TMS
Phrase Strings
Phrase Studio

当上传 Markdown 文件或恢复先前版本时，Phrase 会自动生成 AI 优化版的风格指南。此版本用于 AI 工作流，旨在改善 AI 翻译代理和 MT 优化的结果，而无需为每项任务提供自定义说明。AI 友好型风格指南使 Phrase AI 服务能够根据用户偏好调整语气和正式程度，应用所需的术语和措辞，并遵循特定语言环境的惯例。

虽然 AI 翻译代理会同时考虑术语库和风格指南，但风格指南不会直接强制执行术语库中的术语。使用风格指南不会产生任何额外的 AI 单位 (AIU) 或积分费用。

每份风格指南仅适用于一个区域设置（例如 en-US 或 de-DE）。如果多个变体或用例需要不同的规则，则必须创建单独的风格指南。

组织最多可以添加 500 份风格指南。

注意

在组织启用内容组和规则之前创建的风格指南默认不会链接到内容组，规则也不会自动提取，重新上传文件到此类指南不会触发规则提取。要将风格指南转换为规则，请重新上传该风格指南并在上传过程中选择一个内容组。

权限

只有平台组织管理员可以创建、编辑、删除或设置默认风格指南。
拥有平台成员角色的用户（例如语言专家）可以从资产选项卡查看风格指南。他们无法进行任何修改。
项目经理可以将风格指南附加到项目中。
语言专家和译员可以在 TMS 和 Strings 编辑器中查看附加的风格指南。
用户可以从资产选项卡下载风格指南的最新版本作为 markdown 文件。

文件和结构要求

每个区域设置一个 Markdown (.md) 格式的风格指南：
- 最大大小：150 KB
- 不支持图像
  - Markdown (.md) 文件必须以 UTF-8 编码保存。以 UTF-16 编码保存的文件（例如使用“Unicode”选项从记事本保存的文件），或通过直接从 Microsoft Word 复制内容创建的文件，可能会使用不兼容的编码。上传编码不兼容的文件会导致风格指南内容显示时出现间距错误或乱码。上传前，请在记事本或 VS Code 等文本编辑器中打开文件，选择“另存为”，并将编码选择为 UTF-8。
推荐结构：
1. 目的和范围
2. 声音与语气
3. 语法和写作规则
4. 术语（批准和禁止的术语）
5. 区域设置惯例
6. 格式标准
7. 内容类型指南
8. 故障排除与错误样式（如适用）
清晰的标题和结构化的规则既能提高人类的可读性，也能改善人工智能的解读效果。

示例风格指南文件

以下是一个完整的、无冲突的风格指南示例，可根据需要进行调整：

区域设置：en-US

用例：SaaS B2B 产品 – 帮助中心和用户界面

# 风格指南：美式英语 – 帮助中心文章

## 1.目的与范围

本风格指南定义了所有**帮助中心文档**的**美式英语**书写标准。

它适用于：

- 操作指南文章  
- 功能说明  
- 故障排除指南  
- 常见问题条目  

**受众：**担任技术和业务角色的专业 SaaS 用户  
**目标：**帮助用户快速、自信且不产生困惑地完成任务。

---

## 2.声音与语气

帮助中心的内容应听起来：

- **清晰且专业**
- **支持性且以解决方案为导向**
- **自信，而非推销**

我们的写作定位是帮助用户取得成功的向导，而非营销文案。

### 语气原则

| 建议 | 避免 |
|---|------|
| 保持冷静且直接 | 过于随意或闲聊 |
| 专注于后续步骤 | 只关注出错之处 |
| 使用中性语言 | 使用讽刺或幽默 |

**示例**

- ✅ “如果连接失败，请检查您的 API 令牌并重试。” 
- ❌ “您的令牌错误。修复它。”修复它。”

---

## 3.语法与写作风格

### 3.1 直接称呼读者

使用 **you**（您）使说明更清晰。

- ✅ “您可以从管理页面管理用户。” 
- ❌ “用户可以从管理页面进行管理。”

---

### 3.2 优先使用主动语态

主动语态更简洁，更易于理解。

- ✅ “选择‘保存更改’。” 
- ❌ “应选择‘保存更改’。”

---

### 3.3 保持句子简洁

- 目标是 **25 个单词或更少**
- 每个句子表达一个主要观点
- 将长篇解释拆分为步骤或项目符号

---

### 3.4 使用通俗易懂的语言

避免不必要的复杂性。

- ✅ “开始一个新项目。” 
- ❌ “开始创建新项目。”

---

## 4.术语与一致性

### 4.1 使用核准的术语

请完全按照定义使用产品和功能名称。

- 保持大小写一致  
- 请勿为关键概念编造同义词  

**示例**

- ✅ “workspace”  
- ❌ “space”、“project area”、“environment”

---

### 4.2 定义不常见的缩略语

常用术语（API、URL）无需定义。 
内部或不常见的缩略语应在首次使用时进行解释。

- ✅ “Single Sign-On (SSO)”（单点登录）  
- ❌ 无上下文的“SSO”

---

### 4.3 美式英语规范

始终使用 **en-US 拼写**。

- ✅ “customize”、“behavior”  
- ❌ “customise”、“behaviour”

---

## 5.格式与 Markdown 标准

### 5.1 标题

使用清晰、基于任务的标题。

- ✅ “重置密码”  
- ❌ “密码重置流程概述”

标题层级：

- `#` 文章标题  
- `##` 主要章节  
- `###` 仅在需要时使用的小节  

---

### 5.2 列表

使用编号列表表示顺序：

1.打开 **设置**  
2.选择 **账单**  
3.选择 **更改计划**  

使用项目符号列出选项：

- 管理员可以管理用户  
- 编辑者可以更新内容  

---

### 5.3 UI 元素

统一 UI 标签格式：

- 按钮：**粗体**
- 导航路径：使用箭头

示例：

前往 **设置 → 账单 → 更改计划**。

---

### 5.4 链接

链接必须描述目标位置。

- ✅ “查看账单指南”  
- ❌ “点击此处”

---

## 6.标准文章结构

每篇帮助中心文章都应遵循此结构：

### 1.摘要

以 1–2 句话开头，说明结果。

> 本文介绍了如何更改您的订阅计划。

---

### 2.先决条件（可选）

提前列出要求。

- 管理员权限  
- 有效订阅  

---

### 3.分步说明

步骤应为：

- 以行动为导向  
- 每步仅包含一个动作  
- 以祈使句编写  

示例：

1.前往 **设置**。 
2.选择 **账单**。 
3.选择 **更改计划**。 

---

### 4.预期结果

告知用户应该发生什么。

> 确认后，您的新计划将立即生效。

---

### 5.后续步骤（可选）

提供相关操作或链接。

- 管理发票  
- 更新付款方式  

---

## 7.故障排除与错误

### 7.1 给予安抚

- ✅ “无法连接。请重试。”请重试。” 
- ❌ “连接失败。严重错误。”严重错误。”

---

### 7.2 专注于解决方案

始终包含用户下一步应执行的操作。

- 检查凭据  
- 确认权限  
- 如有需要，请联系支持人员  

---

### 7.3 切勿指责用户

避免使用此类语言：

- “您操作有误”  
- “输入无效”（未作解释）

建议使用：

> “令牌可能已过期。请生成新令牌并重试。”

---

## 8.应做与不应做总结

### 应做

- 编写以任务为中心、基于步骤的内容  
- 使用一致的术语  
- 保持句子简短直接  
- 使用描述性标题和链接  
- 保持冷静、支持性的语气  

### 不要

- 添加营销语言  
- 使用习语或俚语  
- 对同一概念混用术语  
- 在故障排除时责怪用户  
- 编写没有结构的冗长段落  

---

## 示例（推荐）

要更改您的套餐：

1.前往 **设置 → 账单**  
2.选择 **更改套餐**  
3.选择一个选项并点击 **确认**

管理风格指南

风格指南在共享库中创建和管理，可通过 Phrase 平台仪表板左侧导航菜单中的资产进行访问。风格指南页面列出了您组织中可用的所有风格指南。

如果已登录 Phrase TMS、Phrase Strings 或 Phrase Studio，请从左侧导航栏中选择风格指南以打开共享库。

创建风格指南

若要以管理员身份创建新的风格指南，请按照以下步骤操作：

在风格指南页面中，选择新建风格指南。

显示创建风格指南页面。
配置语言、名称和描述（可选）。

名称必须唯一。
拖放或选择上传文件以将风格指南作为 Markdown (.md) 文件上传。
点击创建风格指南。

Phrase 会自动从上传的文件中生成 AI 友好版本。这可能需要几秒钟。

新的风格指南已添加到风格指南页面。
您可以选择设为默认。

将风格指南附加到新项目时，如果未设置特定指南，Phrase 会建议使用默认风格指南。该建议可以被覆盖。

提示

从默认风格指南中删除任何特定于语言的规则。

编辑或删除风格指南

风格指南可以进行更新、版本控制、共享或删除。在风格指南页面中，使用列出的风格指南旁边的更多操作更多菜单菜单来：

设为默认

当新项目中未选择特定指南时，将该风格指南标记为建议的默认设置。默认建议可以在项目级别进行覆盖。
删除

删除风格指南不会追溯更改已完成或正在进行的作业。只有最新版本的风格指南才能附加到新项目中。
提示

在删除风格指南之前，请核实：
- 它是否仍附加到活动项目或模板中
- 是否必须为了合规性或历史参考而保留它
复制公开链接

生成一个只读链接，以便与没有 Phrase 账户的外部利益相关者共享。

在风格指南页面中，选择风格指南旁边的铅笔图标，以打开编辑风格指南页面并更新其元数据、Markdown 文件或默认状态。

在保存之前，可以添加可选的更改描述，以便将其包含在版本历史记录中。仅当替换 Markdown 文件时，才会创建新版本。此版本仅适用于新作业，或适用于在使用该风格指南的项目中尚未开始的作业。

管理版本历史记录

如果现有版本发生更改，风格指南会保留版本历史记录。

要查看版本历史记录并恢复风格指南的版本，请按照以下步骤操作：

在风格指南页面中，点击列表中的风格指南以打开其详细信息页面。
从详细信息页面顶部的更多操作中选择版本历史记录。

显示版本历史记录面板。
选择在先前版本部分中列出的较早版本。

显示旧版本。
如果需要，在版本历史记录中选择从该版本编辑。

以前的版本被恢复，以基于它创建一个新的活动版本。

从早期版本恢复或编辑不会覆盖历史记录。

在项目中使用样式指南

一旦在库中创建了样式指南，它就可以附加到 Phrase TMS、Phrase Strings 和 Phrase Studio 中的项目。

各产品的通用行为：

样式指南按目标语言配置，并应用于整个项目。它们在预翻译时使用 AI 翻译代理，或在使用 MT Optimize 的后期编辑步骤中应用。
当创建样式指南的新版本时，它仅适用于新任务。正在进行的任务继续使用创建时处于活动状态的版本。
在支持的情况下，AI 功能会自动使用附加的样式指南。样式指南不会影响已锁定的片段，因为 MT Optimize 不会修改它们。默认情况下，AI 翻译代理也不会影响来自翻译记忆库（TM）的片段，尽管这可以在预翻译设置中进行配置。

Phrase TMS

样式指南可以附加到项目或项目模板中。

在创建或编辑项目或项目模板时，请导航到资源部分，并为每个目标语言选择一个样式指南。

系统可能会根据区域匹配自动预选最相关的样式指南。预选内容始终可以被覆盖或清除。

注意

经典项目模板视图不支持此功能。
对项目模板的更改仅影响新创建的项目和作业。现有项目不会被追溯更新。
附加的样式指南在CAT 网络编辑器的资源面板中对译员可见，作为只读资源。
- 共享项目中的供应商无法修改买方指定的风格指南。
- 在共享作业场景中，供应商可以使用指定的风格指南，但不能更改项目级配置。

Phrase Strings

在项目页面中，导航至样式指南选项卡，并为每个目标语言环境选择一个样式指南。
附加的风格指南在字符串编辑器侧边栏的风格指南菜单中，在键级别对译员可见。

Phrase Studio

创建项目时，请为添加到项目中的每种目标语言选择一个风格指南。

系统可能会根据区域匹配自动预选最相关的风格指南。预选内容始终可以被覆盖或清除。
AI 友好版本的风格指南会在后台应用，作为 AI 翻译代理工作流的上下文输入。

风格指南 API

风格指南也可通过专用的风格指南公共 API访问，该 API 与 Phrase TMS API 分开。此 API 支持以编程方式创建、更新、检索、搜索和版本化风格指南。新的集成应使用 v2 端点，即 POST /api/v2/styleguides 和 PUT /api/v2/styleguides/{id}，它们将风格指南链接到内容组。该 API 具有区域特定性：

欧盟：https://eu.phrase.com/styleguide
美国：https://us.phrase.com/styleguide

身份验证需要将 Phrase 平台 API 令牌交换为 JWT，如开发者文档中的平台身份验证指南所述。