search

spyder-ide / spyder-docs

Documentation for Spyder, the Scientific Python Development Environment
https://docs.spyder-ide.org
MIT License
33 stars 283 forks source link

Suggestions and issues found during spanish translation of documentation #371

Open LucyJimenez opened 3 months ago

LucyJimenez commented 3 months ago

During the process of translating the Spyder documentation website into Spanish, I encountered several areas for improvement regarding clarity, terminology, and translation consistency. Below are specific observations and suggested enhancements:

  1. Outline section enhancement:

    • Location: Outline Section
    • Issue identified: The image of the Outline panel is not clear enough to indicate where this panel is located or how it can be found within the IDE.
    • Suggested improvement: Please consider updating the image to more accurately depict the Outline panel's position within the Spyder IDE interface.

  2. Terminology in Basic First Aid section:

    • Location: Basic First Aid
    • Issue identified: The phrase “These suggestions, while more of a shotgun approach, tend to fix the majority of reported issues just on their own.” employs a term that may not be universally understood, particularly outside of the United States.
    • Suggested improvement: To ensure broader understanding, it would be beneficial to replace this term with a non-US-centric alternative and avoid using military metaphors.

  3. Clarification needed in Isolating Problems section:

    • Location identified: Isolating Problems
    • Issue identified: The instruction "If you manage to isolate the bug, report it to the last one it doesn’t work in." is ambiguous.
    • Suggested improvement: For clarity, consider rephrasing this instruction to something like, "If you successfully isolate the bug, please report it in the last IDE where it was observed to malfunction."

  4. Translation challenges with target links:

    • General Issue: Target links present significant challenges during the translation process, as they cannot be translated directly, complicating the localization effort.
    • Suggested Improvement: Replacing target links with inline links could streamline the translation process and improve the document's accessibility across different languages.

The proposed changes are aimed at enhancing the documentation's clarity and making it more accessible to a global audience. Your attention to these matters will greatly contribute to improving the overall user experience.