管理

风格指南

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

可用于

  • 早期访问计划(EAP)用户

风格指南是集中管理的语言指南,定义了特定语言或区域的内容书写方式。它们有助于确保语气、术语、格式和输出在项目和团队之间保持一致。

风格指南以Markdown(.md)文件的形式上传,并存储在共享库中,可以通过在Phrase Platform仪表盘的左侧导航菜单中选择资产进行访问。它们可以在以下项目中附加和重用:

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

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

每个风格指南适用于一个特定区域(例如,en-USde-DE)。如果多个变体或用例需要不同的规则,则必须创建单独的风格指南。

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

权限

  • 只有平台组织的管理员可以创建、编辑、删除或设置默认风格指南。

  • 项目经理可以将风格指南附加到项目中。

  • 语言学家和翻译人员可以在TMS和Strings编辑器中查看附加的风格指南。

文件和结构要求

  • 每个区域一个Markdown(.md)格式的风格指南:

    • 最大大小:150 KB

    • 不支持图像

  • 推荐结构:

    1. 目的和范围

    2. 语气和语调

    3. 语法和写作规则

    4. 术语(已核准和禁止的术语)

    5. 区域惯例

    6. 格式标准

    7. 内容类型指导

    8. 故障排除和错误风格(如适用)

    清晰的标题和结构化规则提高了人类可读性和AI解读能力。

示例风格指南文件

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

区域:en-US

使用案例:SaaS B2B产品 – 帮助中心

# 风格指南:EN-US – 帮助中心文章

## 1.目的与范围

本风格指南定义了所有**帮助中心文档**在**英语(美国)**中的写作标准。

适用于:

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

**受众:**在技术和商业角色中的专业SaaS用户  
**目标:**帮助用户快速、自信且不混淆地完成任务。

---

## 2.语气与音调

帮助中心内容应听起来:

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

我们写作是为了帮助用户成功——而不是作为营销文案。

### 音调原则

| 做 | 不要 |
|---|------|
| 保持冷静和直接 | 不要过于随意或闲聊 |
| 专注于下一步 | 只关注出错的地方 |
| 使用中立的语言 | 使用讽刺或幽默 |

**示例**

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

---

## 3.### 3.1 直接与读者对话

使用**你**来使指令清晰。

- ✅ “您可以在管理员页面管理用户。”

- ❌ “用户可以在管理员页面被管理。” 
### 3.2 偏好主动语态

---

主动语态更简短且易于理解。

- ✅ “选择**保存更改**。”

- ❌ “应选择保存更改。” 
### 3.3 保持句子简洁

---

- 目标为**25个单词或更少**

- 每个句子一个主要思想

- 将长篇解释分解为步骤或要点

---

### 3.4 使用简单语言

避免不必要的复杂性。

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

---

## 4.术语与一致性

### 4.1 使用已核准的术语

准确使用产品和功能名称。

- 保持大写字母的一致性  
- 不要为关键概念发明同义词  

**示例**

- ✅ “工作区”  
- ❌ “空间”、“项目区域”、“环境”

---

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

常见术语(API,URL)不需要定义。 
内部或不常见的缩略语应在首次使用时进行解释。

- ✅ “单点登录(SSO)”  
- ❌ “SSO”没有上下文

---

### 4.3 美国英语惯例

始终使用**美式拼写**。

- ✅ “自定义”,“行为”  
- ❌ “自定义”,“行为”

---

## 5.格式化与Markdown标准

### 5.1 标题

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

- ✅ “重置您的密码”  
- ❌ “密码重置过程概述”

标题层级:

- `#` 文章标题  
- `##` 主要部分  
- `###` 仅在需要时使用子部分  

---

### 5.2 列表

使用编号列表表示顺序:

1.打开 **设置**  
2.选择 **账单**  
3.选择 **更改套餐**  

使用项目符号表示选项:

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

---

### 5.3 界面元素

一致地格式化用户界面标签:

- 按钮:**加粗**
- 导航路径:使用箭头

示例:

前往 **设置 → 账单 → 更改套餐**。

---

### 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 Platform 仪表盘中选择 资产 访问左侧导航菜单。风格指南 页面列出了您公司中所有可用的风格指南。

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

创建风格指南

作为管理员创建新的风格指南,请按照以下步骤进行:

  1. 风格指南页面中,选择新建风格指南

    创建风格指南页面已显示。

  2. 配置语言名称描述(可选)。

    名称必须是唯一的。

  3. 拖放或选择上传文件以将风格指南作为Markdown(.md)文件上传。

  4. 点击创建风格指南

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

    新的风格指南已添加到风格指南页面。

  5. 可选,选择设为默认

    在将风格指南附加到新项目时,如果没有设置特定指南,Phrase会建议默认风格指南。该建议可以被覆盖。

    提示

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

编辑或删除风格指南

风格指南可以被更新、版本化、共享或移除。在风格指南页面,从列出的风格指南旁边使用更多操作More Menu菜单:

  • 设为默认

    在新项目中,当未选择特定指南时,将风格指南标记为建议的默认指南。默认建议可以在项目级别被覆盖。

  • 删除

    删除风格指南不会追溯性地更改已完成或正在进行的工作。只有最新版本的风格指南可以附加到新项目。

    提示

    在删除风格指南之前,请验证:

    • 它是否仍然附加在活动项目或模板上

    • 它是否必须保留以满足合规性或历史参考

  • 复制公开链接

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

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

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

管理版本历史

风格指南维护版本历史,以防对现有版本进行更改。

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

  1. 风格指南页面中,单击列表中的风格指南以打开其详细信息页面。

  2. 从详细信息页面顶部的更多操作 More Menu中选择版本历史

    将显示版本历史面板。

  3. 选择先前版本部分中列出的较旧版本。

    将显示较旧版本。

  4. 如有需要,请在此版本中选择版本历史

    之前的版本已恢复,以此创建一个新的可用版本。

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

在项目中使用风格指南

一旦在库中创建了风格指南,就可以将其附加到Phrase TMS、Phrase Strings和Phrase Studio中的项目。

产品间的通用行为:

  • 风格指南按目标语言配置,并适用于整个项目。在使用AI翻译代理进行预翻译时,或在使用MT优化进行译后编辑时应用。

  • 当创建新的风格指南版本时,仅适用于新任务。进行中的任务继续使用创建时的可用版本。

  • AI功能在支持的情况下会自动使用附加的风格指南。风格指南不影响已锁定的段落,因为MT优化不会修改它们。默认情况下,AI翻译代理也不会影响翻译记忆库(TM)中的段落,尽管这可以在预翻译设置中进行配置。

Phrase TMS

风格指南可以附加到项目项目模板

  • 创建或编辑项目或项目模板时,导航到资源部分,并根据目标区域选择风格指南。

    系统可能会根据区域匹配自动预选最相关的风格指南。预选可以随时被覆盖或清除。

    注释

    在经典项目模板视图中不支持。

  • 对项目模板的更改仅影响新创建的项目和工作。现有项目不会被追溯更新。

  • 附加的风格指南在CAT Web Editor资源 paperclip.jpeg窗格中对语言学家可见,作为只读资源。

    • 共享项目中的供应商无法修改买方分配的风格指南。

    • 在共享工作场景中,供应商可以使用分配的风格指南,但无法更改项目级配置。

Phrase Strings

  • 项目页面中,导航到风格指南选项卡,并根据目标区域选择一个风格指南。

  • 附加的风格指南在Strings editor sidebar风格指南菜单中对翻译人员在键级别可见。

Phrase Studio

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

    系统可能会根据区域匹配自动预选最相关的风格指南。预选可以随时被覆盖或清除。

  • 风格指南的AI友好版本在后台作为AI翻译代理工作流的上下文输入应用。

这篇文章有帮助吗?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.