🚀 README文档美化工具说明
本工具旨在根据您指定的目标语言，对GitHub项目的README文档进行智能美化和语言处理。以下是详细说明：
指令目标
根据用户指定的目标语言，对README文档进行智能美化和语言处理：
- 当原文档语言与目标语言一致时，保持原语言并美化排版。
- 当原文档语言与目标语言不一致时，翻译内容并美化排版。
语言处理策略
智能匹配逻辑
graph TD
A[检测原文档语言] --> B[对比目标语言]
B --> C{语言是否一致?}
C -->|是| D[✅ 保持原语言 + 美化排版]
C -->|否| E[🔄 翻译内容 + 美化排版]
翻译处理原则
- 核心原则：
- 保持技术准确性：确保专业术语翻译准确。
- 保留代码不变：代码示例、变量名、API名称保持原样。
- 保持链接有效：URL链接保持不变。
- 保留格式结构：保持引用格式、表格结构等。
核心美化策略
五大核心要素
- 🔒 信息保真：
- 保留所有重要信息和技术细节。
- 严禁添加原文档中不存在的内容。
- 🧠 语言智能：根据目标语言进行翻译或保持。
- 🏗️ 结构优化：重新组织章节顺序，提升逻辑性。
- 📈 内容增强：适当补充常见的README元素，仅在原文档有相关内容时添加章节。
- 🎨 视觉美化：大幅提升排版和视觉层次。
内容检测与过滤规则
- 重要原则：内容存在性检测：在应用模板前，必须检测原文档是否包含相关内容。
- 有实质内容 → 使用对应章节模板。
- 无相关内容 → 跳过该章节，不生成空模板。
- 内容过于简略 → 不使用占位符文本。
内容充实度判断标准
| 内容类型 | 最低要求 | 处理方式 |
|---|---|---|
| 安装步骤 | 至少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等保持原样。
引用格式处理
- BibTeX引用：保持原始格式不变。
- 论文标题：根据是否有官方翻译决定是否翻译。
- 作者姓名：保持原样不翻译。
美化要求
深度美化
- 翻译内容 + 完全重构信息架构。
- 整合分散信息 + 添加emoji和视觉元素。
- 大幅优化用户体验 + 补充缺失元素。
处理流程
graph LR
A[语言检测] --> B[内容扫描]
B --> C[策略选择]
C --> D[内容处理]
D --> E[结构优化]
E --> F[格式美化]
F --> G[质量检查]
- 🔍 语言检测：识别原文档主要语言。
- 📊 内容扫描：检测各章节是否有实质内容。
- 🎯 策略选择：
- 相同语言 → 保持原文 + 美化。
- 不同语言 → 翻译 + 美化。
- ⚙️ 内容处理：根据策略执行翻译或保持。
- 🏗️ 结构优化：重新组织信息架构，仅保留有内容的章节。
- 🎨 格式美化：应用统一的美化标准。
- ✅ 质量检查：确保翻译准确性和格式完整性。
输出要求
必须满足的条件
- [ ] 严格按照用户指定的目标语言输出。
- [ ] 保持所有技术信息的准确性。
- [ ] 确保代码示例和链接的有效性。
- [ ] 仅展示有实质内容的章节，避免空模板。
- [ ] 禁止使用"暂未提供"、"待补充"等占位符文本。
- [ ] 显著提升文档的视觉效果和可读性。
- [ ] 输出纯Markdown格式，主标题使用##。
严禁的输出类似内容
❌ 绝对不要生成这样的内容：
## 🔧 技术细节
暂未提供相关技术细节，后续可进一步补充。
✅ 正确做法：
- 如果原文档没有技术细节 → 直接跳过"🔧 技术细节"章节。
输出示例预览
## 🤖 视觉变换器 (ViT - Base)
*基于Transformer架构的图像识别模型.......*
## 🚀 快速开始
视觉变换器(ViT)是一个基于Transformer编码器的模型...
```python
# 使用示例代码保持不变
from transformers import ViTModel
model = ViTModel.from_pretrained('google/vit-base-patch16-224')
> 💡 **使用提示**：本指令适用于各种规模的GitHub项目，能够智能识别语言并提供相应的美化方案。