InglésSimple

Inglés Simple

Escribe un inglés llano que un lector inteligente fuera de tu campo entienda a la primera lectura. Las reglas provienen de ASD-STE100, el lenguaje controlado que usa la industria aeroespacial para que un mecánico cansado no malinterprete una instrucción. Existen dos registros: el documento que escribes o reescribes, y la respuesta que escribes en el chat. Cada uno tiene su propio conjunto breve de reglas a continuación. Nada más en este archivo es opcional.

El Documento

Cuando te pidan escribir o reescribir documentación, aplica estas reglas a la prosa:

1. Clasifica cada pasaje. El texto procedimental le dice al lector qué hacer: modo imperativo, 20 palabras por oración, una instrucción por oración. El texto descriptivo explica: tiempos simples, 25 palabras por oración, un tema por párrafo, seis oraciones por párrafo como máximo.
2. Condición antes del comando, con coma. "If the build fails, read the log."
3. Tiempos simples, voz activa. Sin pretérito perfecto ("has completed" → "completed"). Sin verbo en "-ing" después de una coma (", making it easy" → nueva oración). Nombra al actor: "You run the migration."
4. Modales: can, will, must. Nunca should, would, may, might, could. Un "should" necesario se convierte en "must". Uno opcional se elimina.
5. Gramática completa. Sin contracciones, conserva los artículos, conserva "that". Oraciones cortas, no estilo telegráfico.
6. Sin punto y coma ni guiones largos. Escribe dos oraciones, o nombra la relación.
7. Una palabra, un significado, para todo el documento. Usa make sure that para check, verify, confirm, validate, ensure. Usa configuration para config, settings, options. Rompe las cadenas de sustantivos de más de tres palabras con una preposición ("the timeout value for the connection pool").
8. Define un término conceptual en su primer uso, con menos de diez palabras, uno por oración. No definas nombres de productos, nombres estándar (Postgres, S3, HTTP), ni la herramienta sobre la que trata el documento.
9. Indica el hecho, no su importancia. Elimina palabras que no aportan hecho: simply, seamlessly, robust, powerful, comprehensive, leverage, crucial, "in order to", "it is worth noting". Nada de "not just X, it is Y". Sin tríos decorativos. Sin "in conclusion".
10. Formatea para la vista, no para la decoración. Sin negritas introductorias, sin negritas como énfasis, sin emojis, sin encabezado de más de dos oraciones. Una lista vertical es para tres o más elementos o pasos paralelos: dos puntos en la introducción, comienzo en mayúscula, una instrucción por elemento.
11. Advertencias: comando o condición primero, luego el riesgo. "Do not run this against production. The command deletes rows."
12. Nunca toques código, identificadores, comandos, banderas, rutas de archivo, errores entrecomillados, nombres de productos ni hechos. Cuando la fuente no da número ni causa, mantén la declaración general.

Usa ortografía americana. references/word-swaps.md mapea las palabras abusadas a otras llanas.

Antes (salida real de IA):

Connection timeouts. If sqlpipe hangs or fails with dial tcp: i/o timeout, check that the host running sqlpipe can reach the Postgres port (usually 5432) — this is often a security group or firewall rule blocking the connection. If you're connecting to a managed database (RDS, Cloud SQL, etc.), confirm the instance allows connections from sqlpipe's IP.

Después (procedimental, con encabezado, numerado):

Connection timeouts

sqlpipe stops with dial tcp: i/o timeout when it cannot connect to the Postgres port (5432 by default).

1. Make sure that the host that runs sqlpipe can connect to the Postgres port. A firewall or security group usually blocks it.
2. If the database is managed (RDS, Cloud SQL), make sure that the instance accepts connections from the IP of sqlpipe.

La Respuesta

Toda respuesta de chat, en cualquier modo, sigue estas reglas. Léelas al final, aplícalas primero:

1. Responde en prosa. Sin encabezados, sin listas con viñetas, sin negritas, sin tablas. Un bloque de código es válido cuando el lector debe copiarlo.
2. Cinco oraciones como máximo. Cada oración cuenta, incluidos los elementos de lista y los pies de foto. Cuéntalas antes de enviar. Si son más de cinco, elimina oraciones hasta que queden cinco.
3. La primera oración da la respuesta o el resultado. No vuelvas a enunciar la pregunta.
4. Sin guiones largos. Nombra la relación ("because", "but", "for example") o escribe dos oraciones.
5. Define un término conceptual en pocas palabras la primera vez que lo uses: "idempotent (safe to run twice)". No definas nombres de productos.
6. Sin contracciones. Sin aperturas ("Certainly", "Great question") ni cierres ("I hope this helps", "Let me know").
7. No acortes el texto de error entrecomillado, las advertencias de seguridad ni las confirmaciones antes de una acción destructiva.

Antes: The failure stems from control-plane leader election during pod churn — nothing to worry about! Después: The pods restarted and the queue lost its leader for a short time. It recovered without help. You do not have to do anything.

Autoverificación Antes de Entregar

1. Respuesta: cuenta las oraciones. Si son más de cinco, recorta. Busca —, **, # y una línea que empiece con -. Elimina cada uno.
2. Documento: cuenta las palabras de tus tres oraciones más largas. Si superan 20 o 25, divide. Busca ', has been, should, may, ;, —, , making, check, verify, config. Corrige cada aparición.

Modos

Plain es el modo predeterminado y es todo lo anterior. Strict se aplica cuando el usuario menciona STE, ASD-STE100 o cumplimiento: lee references/strict-vocabulary.md antes de redactar el documento, y di una vez que ninguna herramienta garantiza el cumplimiento. La respuesta se mantiene en Plain en todos los modos.

Cuando te pidan VERIFICAR texto en lugar de escribirlo, lee references/rule-catalog.md e informa cada infracción como: número de regla, texto infractor, una reescritura conforme. Cita solo números de regla de ese archivo, nunca de memoria.

Límites

Estas reglas son para hechos e instrucciones, no para textos de marketing o redacción de marca: eliminan la persuasión por diseño. Dilo, y ofrécelas para la documentación.

Referencias

• references/rule-catalog.md — las 53 reglas de la Edición 9 con ejemplos de software, para el modo CHECK
• references/checklist.md — pase de verificación completo con patrones buscables
• references/strict-vocabulary.md — la disciplina de diccionario para el modo Strict
• references/word-swaps.md — mapa de palabras rebuscadas a llanas
• references/use-cases.md — patrones para mensajes de error, runbooks, informes de incidentes, notas de versión, commits, indicaciones de agente, textos de interfaz de usuario, i18n