w
Documentation

Multilingual Content Management

This guide explains how to manage and maintain multilingual content on our platform, ensuring that content across all language versions remains synchronized and consistent.

Supported Languages

The platform currently supports the following languages:

  • Simplified Chinese (zh) - Main language
  • Traditional Chinese (zh-Hant) - Traditional Chinese version
  • English (en) - International common language
  • Japanese (ja) - Japanese users
  • Korean (ko) - Korean users
  • French (fr) - French users
  • German (de) - German users
  • Spanish (es) - Spanish users
  • Indonesian (id) - Indonesian users
  • Brazilian Portuguese (pt-BR) - Brazilian users
  • Russian (ru) - Russian users
  • Turkish (tr) - Turkish users

Directory Structure

Multilingual content is organized according to the following structure:

content/
โ”œโ”€โ”€ zh/                    # Simplified Chinese (main language)
โ”‚   โ”œโ”€โ”€ 01.docs/          # Documentation
โ”‚   โ”œโ”€โ”€ 02.guides/        # Guides
โ”‚   โ””โ”€โ”€ 03.tools/         # Tools
โ”œโ”€โ”€ en/                    # English
โ”œโ”€โ”€ ja/                    # Japanese
โ”œโ”€โ”€ ko/                    # Korean
โ”œโ”€โ”€ fr/                    # French
โ”œโ”€โ”€ de/                    # German
โ”œโ”€โ”€ es/                    # Spanish
โ”œโ”€โ”€ id/                    # Indonesian
โ”œโ”€โ”€ pt-BR/                 # Brazilian Portuguese
โ”œโ”€โ”€ ru/                    # Russian
โ”œโ”€โ”€ tr/                    # Turkish
โ””โ”€โ”€ zh-Hant/               # Traditional Chinese

Content Synchronization Principles

1. Main Language Priority

  • Simplified Chinese (zh) is the main language, and all new content is first created in the Chinese version
  • Other language versions are translated based on the Chinese version

2. File Structure Consistency

  • All language versions must maintain the same directory structure
  • File names and paths must be completely consistent
  • Ensure each language version has corresponding files

3. Content Completeness

  • Important documents must have corresponding versions in all languages
  • Prioritize translation of core features and user guides
  • Technical documentation can be prioritized for main languages

Translation Workflow

1. Content Creation

  1. Create new content in the Chinese version
  2. Ensure content structure is clear and easy to translate
  3. Use standard Markdown format

2. Translation Priority

High Priority:

  • User interface text
  • Frequently asked questions
  • Quick start guides
  • Core feature documentation

Medium Priority:

  • Detailed technical documentation
  • API reference documentation
  • Configuration guides

Low Priority:

  • Advanced feature documentation
  • Developer tool documentation
  • Sample code comments

3. Translation Quality Check

  • Ensure translation accuracy and completeness
  • Maintain consistency of technical terms
  • Check for grammar and spelling errors
  • Verify links and references

Automation Tools

Multilingual Content Check Script

Use the built-in check script to verify content synchronization status:

# Check content synchronization status for all languages
node scripts/multilingual-content.js check

# Create missing file structures
node scripts/multilingual-content.js init

# Create welcome pages
node scripts/multilingual-content.js welcome

Content Synchronization Status

The script displays missing files for each language version, helping to identify content that needs translation.

Translation Guidelines

1. Terminology Consistency

Establish a terminology glossary to ensure technical terms are consistent across all languages:

  • API - Keep in English
  • HTTP - Keep in English
  • JSON - Keep in English
  • UUID - Keep in English
  • Base64 - Keep in English

2. Format Standards

  • Use standard Markdown syntax
  • Maintain consistent heading levels
  • Ensure code block formatting is correct
  • Maintain consistency of links and image references

3. Cultural Adaptation

  • Consider expression habits of different cultures
  • Adapt examples and explanations to local users
  • Pay attention to localization of formats such as dates and numbers

Maintenance and Updates

1. Regular Checks

  • Check content synchronization status weekly
  • Identify missing or outdated translations
  • Update terminology glossaries and translation guides

2. Version Control

  • Manage all translation changes through Git
  • Use clear commit messages
  • Create translation branches for collaboration

3. Quality Assurance

  • Establish translation review processes
  • Collect user feedback
  • Continuously improve translation quality

Contribution Guidelines

How to Contribute Translations

  1. Fork the project repository
  2. Create a translation branch
  3. Translate specified content
  4. Submit a Pull Request
  5. Wait for review and merge

Translation Requirements

  • Familiar with target language and domain terminology
  • Maintain accuracy and completeness of original text
  • Follow project translation conventions
  • Respond promptly to feedback and revision suggestions

Frequently Asked Questions

Q: How to handle translation of new features?

A: When releasing new features, handle translation according to the following steps:

  1. Complete feature documentation in Chinese version
  2. Determine translation priority
  3. Assign translation tasks
  4. Complete each language version progressively

Q: How to handle translation of technical terms?

A: Principles for handling technical terms:

  1. Establish a unified terminology glossary
  2. Prioritize industry standard translations
  3. Keep English original when necessary
  4. Provide term explanations in documentation

Q: How to ensure translation quality?

A: Quality assurance measures:

  1. Establish translation review processes
  2. Use automated checking tools
  3. Collect user feedback
  4. Regularly update translation guides

Contact and Support

If you encounter problems during the translation process:

Last Updated: December 2024 Document Version: 1.0.0

Was this page helpful?
Common IssuesDevelopers