Doc Translator

2. 代码块处理

保持原样的内容：

def hello_world():
    print("Hello, World!")

npm install react

{
  "name": "my-app",
  "version": "1.0.0"
}

可翻译的内容：

• 代码注释可以翻译为中文

# Calculate the total price
def calculate_total(items):
    return sum(item.price for item in items)

翻译为：

# 计算总价
def calculate_total(items):
    return sum(item.price for item in items)

3. 格式保持

• Markdown格式：保持标题层级、列表、表格、链接等
• 代码块：保持语言标识符和缩进
• 链接：保持URL和链接文本（可翻译链接文本）
• 图片：保持图片链接和alt文本（可翻译alt文本）

4. 语言风格

• 使用清晰、专业的中文表达
• 避免直译，注重中文表达的自然流畅
• 保持技术文档的专业性和准确性
• 使用一致的术语翻译

翻译流程

第一步：分析原文结构

1. 识别文档类型

   • 技术文档（API文档、开发指南、架构文档）
   • 用户手册（安装指南、使用说明）
   • 项目文档（README、CHANGELOG）
   • 其他类型

2. 理解文档结构

   • 章节划分
   • 段落组织
   • 代码块位置
   • 特殊格式元素

3. 识别关键内容

   • 技术术语
   • 代码块
   • 命令行指令
   • 文件路径

第二步：分段翻译

1. 按章节翻译

   • 保持章节顺序
   • 确保上下文连贯性
   • 保持术语一致性

2. 处理特殊元素

   • 代码块：保持原样
   • 链接：保持URL，翻译链接文本
   • 表格：翻译内容，保持格式
   • 列表：翻译列表项

3. 术语一致性检查

   • 同一术语使用相同翻译
   • 建立术语表（可选）
   • 参考行业标准翻译

第三步：质量检查

1. 语义检查

   • 确保翻译与原文含义一致
   • 检查是否有遗漏或错误理解
   • 验证技术概念的准确性

2. 语法检查

   • 检查句子结构是否正确
   • 确保表达流畅自然
   • 消除翻译腔

3. 格式检查

   • 验证Markdown格式完整
   • 确认代码块未被误译
   • 检查链接和引用

4. 术语检查

   • 确保技术术语使用准确
   • 检查术语翻译的一致性
   • 验证是否符合行业标准

翻译示例

示例1：技术文档

原文（英语）：

# Getting Started

This guide will help you set up the development environment for the project.

## Prerequisites

Before you begin, make sure you have the following installed:
- Node.js 16 or higher
- npm 8 or higher
- Git

## Installation

1. Clone the repository:
```bash
git clone https://github.com/example/project.git
cd project

2. Install dependencies:

npm install

3. Start the development server:

npm run dev

The application will be available at http://localhost:3000

**翻译后（中文）：**
```markdown
# 快速开始

本指南将帮助您设置项目的开发环境。

## 前置要求

在开始之前，请确保已安装以下软件：
- Node.js 16 或更高版本
- npm 8 或更高版本
- Git

## 安装步骤

1. 克隆仓库：
```bash
git clone https://github.com/example/project.git
cd project

2. 安装依赖：

npm install

3. 启动开发服务器：

npm run dev

应用程序将在 http://localhost:3000 上运行

### 示例2：API文档

**原文（英语）：**
```markdown
## User API

### Create User

Creates a new user account.

**Endpoint:** `POST /api/users`

**Request Body:**
```json
{
  "username": "johndoe",
  "email": "[email protected]",
  "password": "securepassword123"
}

Response:

{
  "id": 123,
  "username": "johndoe",
  "email": "[email protected]",
  "createdAt": "2024-01-15T10:30:00Z"
}

**翻译后（中文）：**
```markdown
## 用户 API

### 创建用户

创建新的用户账户。

**端点：** `POST /api/users`

**请求体：**
```json
{
  "username": "johndoe",
  "email": "[email protected]",
  "password": "securepassword123"
}

响应：

{
  "id": 123,
  "username": "johndoe",
  "email": "[email protected]",
  "createdAt": "2024-01-15T10:30:00Z"
}

### 示例3：代码注释翻译

**原文（英语）：**
```python
class UserService:
    """Service class for managing user operations."""
    
    def __init__(self, db_connection):
        """Initialize the service with database connection."""
        self.db = db_connection
    
    def get_user(self, user_id):
        """Retrieve user by ID from the database.
        
        Args:
            user_id: The unique identifier of the user
            
        Returns:
            User object if found, None otherwise
        """
        # Query the database for the user
        query = "SELECT * FROM users WHERE id = %s"
        result = self.db.execute(query, (user_id,))
        return result.fetchone() if result else None

翻译后（中文）：

class UserService:
    """用于管理用户操作的服务类。"""
    
    def __init__(self, db_connection):
        """使用数据库连接初始化服务。"""
        self.db = db_connection
    
    def get_user(self, user_id):
        """从数据库中根据ID检索用户。
        
        参数:
            user_id: 用户的唯一标识符
            
        返回:
            如果找到则返回用户对象，否则返回None
        """
        # 查询数据库获取用户信息
        query = "SELECT * FROM users WHERE id = %s"
        result = self.db.execute(query, (user_id,))
        return result.fetchone() if result else None

注意事项

不要翻译的内容

1. 技术术语

   • 编程语言名称：Python, Java, JavaScript等
   • 框架和库名称：React, Vue, Spring Boot等
   • 协议和标准：HTTP, REST, JSON, XML等
   • 开发工具：Git, Docker, Kubernetes等

2. 代码相关

   • 代码块内容
   • 变量名、函数名、类名
   • 关键字和语法元素
   • 文件路径和文件名

3. 命令和配置

   • 命令行指令
   • 配置文件内容
   • URL链接
   • 环境变量

需要翻译的内容

1. 文档结构

   • 标题
   • 章节和段落
   • 列表项
   • 表格内容

2. 说明文字

   • 描述性文本
   • 操作步骤
   • 注意事项和警告
   • 示例说明

3. 代码注释（可选）

   • 根据需求决定是否翻译
   • 保持代码格式不变

特殊情况处理

1. 混合语言文档

   • 如果原文中已经包含中文，保持原样
   • 确保翻译后的语言风格一致

2. 不确定的术语

   • 保持英文并在括号中添加中文解释
   • 例如：使用 Webhook（网络钩子）机制

3. 专有名词

   • 公司名称、产品名称保持英文
   • 例如：Google, Microsoft, Amazon

4. 缩写词

   • 常见缩写保持英文：API, SDK, CLI等
   • 不常见缩写可翻译并保留英文

质量标准

翻译完成后，应满足以下质量标准：

语义准确性

• ✅ 翻译与原文含义完全一致
• ✅ 技术概念准确传达
• ✅ 无遗漏重要信息
• ✅ 无添加无关信息

语法正确性

• ✅ 句子结构正确
• ✅ 表达流畅自然
• ✅ 符合中文语法规范
• ✅ 无翻译腔

术语一致性

• ✅ 同一术语使用相同翻译
• ✅ 技术术语使用准确
• ✅ 符合行业标准
• ✅ 术语表一致（如有）

格式完整性

• ✅ Markdown格式完整
• ✅ 代码块完整保留
• ✅ 链接和引用正确
• ✅ 表格格式正确

专业性

• ✅ 语言专业规范
• ✅ 符合技术文档风格
• ✅ 术语使用恰当
• ✅ 表达清晰准确

常见技术术语翻译参考