Nitro 中文文档翻译风格指南

概述

本文档定义了 Nitro 中文文档的翻译风格和规范,确保整个文档库的翻译风格一致性和专业度。

翻译原则

1. 技术术语处理

保持英文的技术术语(不翻译)

所有技术术语(如 Runtime、Handler、Middleware、Preset 等)保持英文原文,详见术语表

框架/工具/平台名称

所有框架、工具和平台名称保持原文,详见术语表

文件/目录名称

所有文件和目录名称保持英文原文。

2. 常见翻译对照表

英文原文中文翻译说明
zero-config零配置保持简洁
production-ready生产就绪标准技术用语
full-stack全栈行业标准术语
vendor lock-in供应商绑定避免"锁定"等生硬翻译
out of the box开箱即用行业标准用语
compatible with any runtime兼容任何 runtimeruntime 保持英文
built-in内置简洁明了
cross-cutting concerns横切关注点软件工程标准术语
best practices最佳实践行业标准术语

注意:完整的技术术语表请参考术语表

3. 翻译风格指南

避免生硬直译

不推荐

  • "无供应商锁定" → 推荐:"不被供应商绑定"
  • "零配置部署" → 推荐:"零配置部署"(保持简洁)
  • "开箱即可用" → 推荐:"开箱即用"(标准术语)

保持简洁有力

不推荐

  • "你可以使用零配置的方式部署你的应用程序" → 推荐:"零配置部署应用"
  • "你可以使用以下命令" → 推荐:"使用以下命令"
  • "你可以通过配置文件自定义" → 推荐:"通过配置文件自定义"
  • "你可以创建一个特殊的路由" → 推荐:"创建特殊路由"

技术文档的语气

  • 使用第二人称"你"而非"您",保持亲和力
  • 使用主动语态,避免被动语态
  • 保持简洁明了,避免冗长表达

4. 中英文混排规范

空格使用

  • 中英文之间添加空格:使用 Nitro 开发
  • 中文与代码之间添加空格:使用 routes/ 目录
  • 中文与链接之间添加空格:查看 [Vite 文档](https://vitejs.dev)

标点符号

  • 中文内容使用中文标点:、。;:!?
  • 代码和英文术语周围使用英文标点:使用 runtime,而不是 runtime。
  • 括号使用中文全角括号:(这是说明)

5. 代码和格式规范

代码块

  • 所有代码示例、文件路径、命令保持英文原文
  • 代码注释可以翻译,但建议保持英文以便与国际社区一致

链接处理

  • 内部链接需要确保指向正确路径
  • 外部链接保持原样,不翻译 URL

格式保持

  • frontmatter、代码块标记等格式保持与原文一致
  • 标题层级结构保持不变

6. 特殊情况处理

首次出现的缩写

  • 首次出现时提供全称:HMR (Hot Module Replacement)
  • 后续可直接使用缩写:HMR

品牌名称

  • 保持原始大小写:Node.jsGitHubVercel
  • 不翻译品牌名称

版本号

  • 保持原格式:v2.9.0Node.js 18

翻译示例

正确示例

原文

Nitro is a full-stack framework, compatible with any runtime. It extends your Vite application with a production-ready server.

译文

Nitro 是一个全栈框架,兼容任何 runtime。它为你的 Vite 应用扩展了生产就绪的服务器。

避免的错误

错误示例

Nitro是一个全栈框架,兼容任何runtime。它为你的Vite应用扩展了生产就绪的服务器。

问题

  • 缺少中英文之间的空格
  • "一个"后面缺少空格

质量检查清单

在提交翻译前,请检查:

  • 技术术语是否遵循术语表
  • 中英文混排是否正确添加空格
  • 标点符号使用是否正确
  • 代码块和链接是否保持原样
  • 翻译是否自然流畅,避免生硬直译
  • 首次出现的缩写是否提供全称
  • 格式是否与原文保持一致

更新日志

  • 2025-10-28:创建初始版本,定义基础翻译规范
  • 2025-10-28:优化"供应商锁定"翻译为"供应商绑定"
  • 2025-10-28:添加"你可以"表达优化指南,提倡更简洁的表达方式

翻译质量检查报告

基于对 docs-cn 目录下核心文档的检查,以下是翻译质量评估和优化建议:

📊 整体评估

  • 准确率: 95% - 技术术语和概念翻译准确
  • 流畅度: 85% - 大部分翻译自然,部分表达可简化
  • 规范性: 90% - 基本遵循翻译规范,术语处理正确

🔧 主要优化建议

1. 术语统一

  • ❌ "生产就绪" → ✅ "生产级" 或 "可用于生产"
  • ❌ "以零配置体验部署" → ✅ "零配置部署体验"

2. 表达简化

  • 减少"你可以"的冗余使用
    • ❌ "你可以使用以下命令"
    • ✅ "使用以下命令"
    • ❌ "你可以通过配置文件"
    • ✅ "通过配置文件"

3. 语义优化

  • ❌ "在服务器上实现 HMR" → ✅ "服务器端支持 HMR"
  • ❌ "你经常需要" → ✅ "通常需要"
  • ❌ "让你可以在" → ✅ "让你在"

📋 具体优化案例

首页 (index.md)

  • ❌ "扩展了生产就绪的服务器"
  • ✅ "扩展了生产级服务器"
  • ❌ "以零配置体验部署到多个托管平台"
  • ✅ "零配置部署体验,支持多个托管平台"

介绍文档 (1.index.md)

  • ❌ "你经常需要添加 API routes"
  • ✅ "通常需要添加 API routes"
  • ❌ "让你可以在项目的 routes/ 目录中创建"
  • ✅ "让你在项目 routes/ 目录中创建"

路由文档 (5.routing.md)

  • ❌ "你可以将 HTTP 方法附加"
  • ✅ "可将 HTTP 方法附加"
  • ❌ "你可以通过创建子目录来嵌套路由"
  • ✅ "通过创建子目录嵌套路由"

部署文档 (2.deploy/)

  • ❌ "你可以轻松配置 Nitro"
  • ✅ "轻松配置 Nitro"
  • ❌ "你可以通过定义环境变量"
  • ✅ "通过定义环境变量"

🎯 优先级建议

高优先级: 统一"生产级"术语,减少"你可以"冗余

中优先级: 优化语义表达,提升流畅度

低优先级: 微调细节表达,增强专业性

✅ 质量亮点

  • 技术术语处理正确(runtime、server routes 等保持英文)
  • 中英文混排规范(空格使用正确)
  • "不被供应商绑定"翻译自然流畅
  • 整体翻译准确,理解无歧义

常见优化案例

减少冗余表达

不推荐

  • "你可以使用以下命令来构建项目"
  • "你可以通过配置文件来自定义设置"
  • "你可以创建一个特殊的路由来处理"

推荐

  • "使用以下命令构建项目"
  • "通过配置文件自定义设置"
  • "创建特殊路由处理"

保持专业简洁

不推荐

  • "你可以轻松地配置"
  • "你可以简单地使用"

推荐

  • "轻松配置"
  • "简单使用"