Back to all reviewers

Documentation translation guidelines

fastapi/fastapi
Based on 9 comments
Markdown

Maintain consistency and accuracy when translating documentation. Ensure technical terms and special formatting elements are handled properly according to project guidelines.

Documentation Markdown

Reviewer Prompt

Maintain consistency and accuracy when translating documentation. Ensure technical terms and special formatting elements are handled properly according to project guidelines.

When translating documentation:

  1. Preserve special formatting: Keep formatting elements like admonitions intact, following project-specific patterns. For example with info boxes:
    /// tip | Dica
    Content goes here
    ///
    

    Don’t change the word immediately after /// as it determines the box’s styling.

  2. Handle technical terms appropriately: Consider whether technical terms should be translated or kept in their original form based on common usage in the target language.
    # In Korean translation
    # Better: "오버헤드" (keeping technical term "overhead")
    # Instead of: "추가적인 시간" (translating as "additional time")
    
  3. Maintain consistent terminology: Use the same translation for recurring terms throughout the documentation.

  4. Add context when needed: Include examples for abbreviations or technical concepts to improve clarity.

  5. Don’t modify original content: When translating, avoid changing the source code examples unless translating comments.
9
Comments Analyzed
Markdown
Primary Language
Documentation
Category

Source Discussions