根据用户指定的目标语言,对README文档进行智能美化和语言处理:
graph TD
A[检测原文档语言] --> B[对比目标语言]
B --> C{语言是否一致?}
C -->|是| D[✅ 保持原语言 + 美化排版]
C -->|否| E[🔄 翻译内容 + 美化排版]
⚠️ 核心原则
- 保持技术准确性:确保专业术语翻译准确
- 保留代码不变:代码示例、变量名、API名称保持原样
- 保持链接有效:URL链接保持不变
- 保留格式结构:保持引用格式、表格结构等
⚠️ 重要原则:内容存在性检测
在应用模板前,必须检测原文档是否包含相关内容:
- ✅ 有实质内容 → 使用对应章节模板
- ❌ 无相关内容 → 跳过该章节,不生成空模板
- ❌ 内容过于简略 → 不使用占位符文本
内容类型 | 最低要求 | 处理方式 |
---|---|---|
安装步骤 | 至少1个具体安装命令 | 有 → 展示;无 → 跳过 |
使用示例 | 至少1个代码示例 | 有 → 展示;无 → 跳过 |
技术细节 | 具体的技术说明(>50字) | 有 → 展示;无 → 跳过 |
API文档 | 至少1个API接口说明 | 有 → 展示;无 → 跳过 |
## 🚀 [项目标题 - 目标语言]
[核心功能描述,2 - 3行简洁说明项目解决的问题和价值 - 目标语言]
graph TD
A[扫描原文档] --> B{检测章节内容}
B -->|有实质内容| C[应用对应模板]
B -->|无内容/过于简略| D[跳过该章节]
C --> E[生成美化章节]
D --> F[继续检测下一章节]
## 🚀 快速开始 # 必需章节,始终显示
## ✨ 主要特性 # 当原文档有功能描述时显示
## 📦 安装指南 # 当原文档有安装步骤时显示
## 💻 使用示例 # 当原文档有代码示例时显示
## 📚 详细文档 # 当原文档有详细说明时显示
## 🔧 技术细节 # 当原文档有技术实现细节时显示
## 📄 许可证 # 当原文档有许可证信息时显示
❌ 避免生成的空内容示例:
## 🔧 技术细节
暂未提供相关技术细节,后续可进一步补充。
## 💻 使用示例
### 基础用法
```python
# [保持原始代码和注释不变]
original_code_content
# [高级场景说明 - 目标语言]
original_code_content
#### 信息表格模板
```markdown
| 属性 | 详情 |
|------|------|
| 模型类型 | [翻译后的内容] |
| 训练数据 | [翻译后的内容] |
> ⚠️ **重要提示**
>
> [翻译后的提示内容]
> 💡 **使用建议**
>
> [翻译后的建议内容]
标准 | 要求 |
---|---|
专业术语准确 | 使用标准的技术翻译 |
语言自然流畅 | 符合目标语言表达习惯 |
上下文一致 | 保持文档整体语言风格统一 |
格式完整保留 | 所有markdown格式保持不变 |
📋 保持不变的元素
- 代码块:代码内容和注释保持原样
- API名称:函数名、变量名、类名等保持英文
- URL链接:所有链接地址保持不变
- 品牌名称:公司名、产品名等专有名词谨慎翻译
- 文件名:如
README.md
、config.json
等保持原样
graph LR
A[语言检测] --> B[内容扫描]
B --> C[策略选择]
C --> D[内容处理]
D --> E[结构优化]
E --> F[格式美化]
F --> G[质量检查]
❌ 绝对不要生成这样的内容:
## 🔧 技术细节
暂未提供相关技术细节,后续可进一步补充。
✅ 正确做法:
## 🤖 视觉变换器 (ViT - Base)
*基于Transformer架构的图像识别模型.......*
## 🚀 快速开始
视觉变换器(ViT)是一个基于Transformer编码器的模型...
```python
# 使用示例代码保持不变
from transformers import ViTModel
model = ViTModel.from_pretrained('google/vit-base-patch16-224')
#### 英文输出示例
```markdown
## 🤖 Vision Transformer (ViT - Base)
*Transformer - based model for image recognition*
## 🚀 Quick Start
Vision Transformer (ViT) is a transformer encoder model...
```python
# Code examples remain unchanged
from transformers import ViTModel
model = ViTModel.from_pretrained('google/vit-base-patch16-224')
> 💡 **使用提示**:本指令适用于各种规模的GitHub项目,能够智能识别语言并提供相应的美化方案。