Acerca de la escritura de contenido que facilita la traducción
Sigue las instrucciones que se indican a continuación para asegurarte de que el contenido que creas se pueda traducir correctamente. Para obtener más información, consulta esta guía de estilo.
- Usa ejemplos que sean genéricos y que pueda entender la mayoría de las personas.
- Evita ejemplos que sean controvertidos o culturalmente específicos de un grupo.
- Escribe en voz activa.
- Escribe frases sencillas, cortas y fáciles de entender.
- Evita usar demasiados pronombres que puedan hacer que el texto no quede claro.
- Evita usar jerga y bromas.
- Evita frases negativas.
- Usa acrónimos estándar del sector siempre que sea posible y explica los acrónimos personalizados.
- Usa el modo indicativo.
- Elimina las expresiones redundantes y verbosas.
- Evita el uso excesivo de modificadores seguidos (secuencias de sustantivos). El traductor puede malinterpretar qué sustantivo es el que se está modificando.
- Evita plurales invisibles en los que no está claro si el primer sustantivo es singular o plural.
- Evita la nominalización.
- Evita usar verbos auxiliares modales ambiguos.
- Evita palabras específicas del género.
- Evita frases preposicionales.
- Evita sustantivos y pronombres imprecisos (sujeto ambiguo de la oración).
- Reduce al mínimo los vínculos insertados. Si son necesarios, pon delante una frase como "For more information, see 'Link title'". También puedes agregar vínculos pertinentes en una sección "Further reading" al final del tema.
Ejemplos
En esta sección se proporcionan ejemplos de cómo seguir nuestras directrices para escribir documentación fácil de traducir.
Evitar información específica del país
Por ejemplo, evita los números de teléfono 800 y direcciones específicas del país. Si es necesario, menciona a qué países se aplica la información.
Evitar el uso excesivo de modificadores seguidos (secuencias de sustantivos)
Muchos modificadores seguidos pueden dar lugar a traducciones incorrectas, porque no es fácil determinar qué modifica a qué. Por ejemplo, usa "Default source settings for the public repository" en lugar de "public repository default source settings".
Evitar plurales invisibles
Por ejemplo, al usar el término "file retrieval", no está claro si se recupera un archivo o todos los archivos. Proporciona más contexto para eliminar la ambigüedad. En el ejemplo dado, puedes usar "retrieving all the files" o "retrieving the source.md file".
Evitar la nominalización
Por ejemplo, en lugar de "to reach a conclusion", usa "conclude".
Evita usar verbos auxiliares modales ambiguos
Evita usar palabras como "may" y "might". Sé más claro para evitar la ambigüedad.
Evitar frases preposicionales
En lugar de escribir "after trying many times" o "according to the repository log", escribe de una forma más directa. Por ejemplo, "after trying three times".
Evitar sustantivos y pronombres imprecisos
Los sustantivos y pronombres imprecisos pueden hacer que no quede claro a quién o a qué te refieres, especialmente cuando ese contenido tiene que traducirse. Por ejemplo, "Maintainers and contributors have access to files and comments. In the pull request they make changes to it". En esta frase, no está claro si los cambios se realizan en el archivo o en los comentarios. Si un pronombre parece referirse a más de un antecedente, vuelve a formular la frase para que el antecedente esté claro o reemplaza el pronombre por un sustantivo para eliminar la ambigüedad.
Reducir al mínimo los vínculos insertados
Siempre que sea posible, introduce los vínculos claramente siguiendo nuestra guía de estilo. Por ejemplo, en lugar de esta oración:
Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.
Puedes usar esta:
OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)."