|
| 1 | +# Python Documentation Translation Dictionary |
| 2 | + |
| 3 | +This document describes the terminology dictionaries for maintaining translation consistency across the Python documentation project. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +The translation dictionary project provides curated key terms and their translations to help translators maintain consistent terminology usage across different documents. The dictionaries are maintained using LLM knowledge to identify and categorize important Python terminology. |
| 8 | + |
| 9 | +## Generated Files |
| 10 | + |
| 11 | +### terminology_dictionary.csv |
| 12 | +The complete terminology dictionary containing important terms identified from Python documentation. Contains: |
| 13 | +- **source_term**: The original English term |
| 14 | +- **translated_term**: The corresponding Chinese (Traditional) translation |
| 15 | +- **frequency**: Number of occurrences across all files |
| 16 | +- **files_count**: Number of different files containing this term |
| 17 | +- **source_file**: Example file where this term was found |
| 18 | +- **directory**: Directory of the source file |
| 19 | +- **example_files**: List of up to 5 files containing this term |
| 20 | + |
| 21 | +Total entries: ~196 essential Python terms |
| 22 | + |
| 23 | +### focused_terminology_dictionary.csv |
| 24 | +A curated subset of ~118 terms focusing on the most important Python terminology. Includes additional columns: |
| 25 | +- **priority**: High/Medium priority classification |
| 26 | +- **category**: Term classification |
| 27 | + |
| 28 | +#### Categories: |
| 29 | +- **Core Concepts** (7 terms): class, function, method, module, package, object, type |
| 30 | +- **Built-in Types** (9 terms): int, str, list, dict, tuple, set, float, bool, complex |
| 31 | +- **Keywords/Constants** (25 terms): None, True, False, return, import, def, async, await, and other Python keywords |
| 32 | +- **Exceptions** (29 terms): Common *Error and *Exception classes |
| 33 | +- **Code Elements** (14 terms): Magic methods like __init__, __str__, etc. |
| 34 | +- **Common Terms** (34 terms): Important technical concepts like decorator, generator, iterator |
| 35 | + |
| 36 | +## Maintenance |
| 37 | + |
| 38 | +The terminology dictionaries are maintained using LLM knowledge to identify important Python terms and their translations. The dictionaries can be updated as needed to reflect new terminology or improved translations. |
| 39 | + |
| 40 | +## Integration with Translation Workflow |
| 41 | + |
| 42 | +### For New Translators |
| 43 | +1. Start with `focused_terminology_dictionary.csv` |
| 44 | +2. Learn standard translations for core Python concepts |
| 45 | +3. Reference high-frequency terms for consistency |
| 46 | + |
| 47 | +### For Translation Review |
| 48 | +1. Check new translations against the dictionary |
| 49 | +2. Verify consistent terminology usage |
| 50 | +3. Update dictionary when establishing new standard translations |
| 51 | + |
| 52 | +### For Project Management |
| 53 | +1. Track translation progress for key technical terms |
| 54 | +2. Identify terminology needing standardization |
| 55 | +3. Prioritize translation efforts using frequency data |
| 56 | + |
| 57 | +### Output Format |
| 58 | +CSV files use UTF-8 encoding to properly handle Chinese characters. Compatible with Excel, Google Sheets, and other spreadsheet applications. |
| 59 | + |
| 60 | +## Maintenance |
| 61 | + |
| 62 | +### Adding New Terms |
| 63 | +New terms can be identified and added based on: |
| 64 | +- Frequency of appearance in documentation |
| 65 | +- Importance to Python concepts |
| 66 | +- Consistency needs across translation files |
| 67 | + |
| 68 | +### Manual Curation Process |
| 69 | +The dictionaries are maintained through careful analysis of: |
| 70 | +- Core Python terminology in official documentation |
| 71 | +- Existing translation patterns in .po files |
| 72 | +- Category-based organization for translator efficiency |
| 73 | + |
| 74 | +### Quality Assurance |
| 75 | +- Regular review of term translations for consistency |
| 76 | +- Cross-reference with official Python terminology |
| 77 | +- Validation against established translation conventions |
| 78 | + |
| 79 | +This documentation provides comprehensive guidance for maintaining and using the translation dictionary system to ensure consistent, high-quality Python documentation translation. |
0 commit comments