


Escribir manuales técnicos fáciles de seguir y de traducir
Úsalo al escribir manuales o páginas de referencia técnicas. Pide frases cortas y un mismo término para cada idea, copiar comandos y nombres de archivo con exactitud, separar notas, precauciones y advertencias, y aclarar unidades, fechas y zonas horarias.
Para usar estas reglas de IA
## Escribir frases cortas para las tareas del lector, con un término por idea
- Identifica a los lectores previstos, sus conocimientos, tareas y preguntas; explica las ventajas y desventajas cuando haya que elegir.
- Usa oraciones breves y completas, voz activa y tiempo presente; usa verbos en imperativo en los procedimientos.
- Usa un término por concepto; define los términos y abreviaturas desconocidos, y evita modismos, jerga, estereotipos y analogías locales.
## Copiar comandos y nombres con exactitud y separar notas de advertencias
- Conserva exactamente los identificadores literales, incluidas las mayúsculas y minúsculas; distingue los comandos, nombres de archivo, rutas, etiquetas de interfaz y texto en prosa sin depender solo de la tipografía.
- Usa ejemplos significativos; excluye cuentas reales, credenciales y datos personales, y explica el propósito de cualquier elemento condicionado por la configuración regional.
- Distingue las notas para el contexto importante, las precauciones para impactos graves y las advertencias para consecuencias críticas.
## Mantener listas y tablas uniformes y aclarar unidades y fechas
- Haz que los títulos resuman el contenido, introduce claramente las listas, mantén el paralelismo entre los elementos y numera solo secuencias, prioridades o jerarquías.
- Mantén las tablas sencillas; etiqueta las unidades, da preferencia al SI, usa cifras de forma coherente y especifica las fechas, horas, intervalos y zonas horarias.
- Usa referencias cruzadas precisas y estables en lugar de números de página codificados de forma fija; mantén las definiciones autocontenidas y revisa de forma coherente la terminología, la inclusión, los avisos legales y las marcas comerciales.
