Free-cat/ste100

ASD-STE100 Inglés Técnico Simplificado

STE es un lenguaje controlado: 53 reglas de escritura y un diccionario de aproximadamente 900 palabras aprobadas, cada una con un único significado y una categoría gramatical. El propósito es que un lector con inglés limitado, o un traductor, pueda entender cada oración de una sola manera.

Seleccione el trabajo

Trabajo	El usuario le da	Usted devuelve
Escribir	Notas, hechos, un esquema o una solicitud	Un documento nuevo en STE
Revisar	Un documento existente	Un informe de hallazgos. Sin reescritura.
Editar	Un documento existente	El documento en STE y un resumen de cambios

Si la solicitud no está clara ("mira este doc"), haga una Revisión y ofrezca la Edición.

Recursos

• references/rules.md — las 53 reglas con ejemplos. Léalo para un trabajo de Revisión o Edición, y cuando no esté seguro sobre una regla.
• references/dictionary.md — palabras no aprobadas con alternativas aprobadas, trampas de categoría gramatical, categorías de sustantivos técnicos y verbos técnicos, y una sección para texto de software. Léalo para cada trabajo. La mayoría de las violaciones son de elección de palabras.
• scripts/ste_check.py — encuentra las violaciones que un programa puede encontrar. Ejecútelo; no lo lea. Solo requiere la biblioteca estándar de Python 3. Lee un archivo e imprime hallazgos. No modifica archivos ni usa la red.

python3 scripts/ste_check.py <archivo> [--type auto|procedure|description] [--terms terms.txt] [--json]

--terms toma un archivo con un sustantivo o verbo técnico por línea (por ejemplo press, torque). El script entonces deja de reportar esas palabras.

El script es una primera pasada. No puede encontrar sustantivos compuestos largos, un significado incorrecto, artículos faltantes o términos inconsistentes. También reporta algo de texto correcto (un participio pasado usado como adjetivo parece voz pasiva). Examine cada hallazgo.

Las reglas que causan más violaciones

1. Palabras aprobadas (1.1–1.3). Use palabras del diccionario con su categoría gramatical y significado aprobados. Check y test son sustantivos ("Do a check of…", "Make sure that…"). Close es un verbo (escriba "near").
2. Sustantivos y verbos técnicos (1.5–1.13). Las palabras del campo temático provienen de fuera del diccionario: piezas, herramientas, materiales, objetos de software, unidades (sustantivos), y procesos específicos como drill, weld, click, deploy (verbos). Use un término para una cosa. Un verbo general (verify, perform, utilize) nunca es un verbo técnico.
3. Formas verbales (3.1–3.5). Infinitivo, imperativo, presente simple, pasado simple, futuro simple y el participio pasado como adjetivo. No hay tiempo perfecto ("has failed"), no progresivo ("is running"), no forma -ing a menos que sea un sustantivo técnico ("bearing", "operating temperature").
4. Verbos modales. Solo CAN y MUST. No should, may, might, could, would, shall.
5. Voz activa (3.6). Siempre en procedimientos. En descripciones, la pasiva se permite solo si el agente es desconocido o no es importante.
6. Longitud de la oración (5.1, 6.3). Procedimiento: 20 palabras. Descripción: 25 palabras. El código, un número con su unidad, una etiqueta y el texto entre paréntesis cuentan como una palabra cada uno.
7. Una instrucción en cada oración (5.2–5.4). Escriba un comando. Combine dos acciones solo si ocurren al mismo tiempo. Coloque una condición primero, luego una coma.
8. No omita palabras (4.2, 4.5). Mantenga los artículos y "that". Sin contracciones.
9. Sustantivos compuestos (2.1). Máximo tres sustantivos. Divida uno más largo con "of", "for", "that" o un guion.
10. Seguridad y notas (7.1–7.3, 5.5). Una advertencia o precaución comienza con un comando o condición, da el riesgo y va antes del paso al que se aplica. Una nota da solo información. Si una nota contiene una instrucción, conviértala en un paso. El texto de seguridad obedece las mismas reglas verbales: "The threads can become damaged" o "This can cause damage to the threads", no "The threads can be damaged".
11. Párrafos (6.4–6.6). Un tema, oración temática primero, máximo seis oraciones. Use una lista vertical para tres o más elementos paralelos (4.3). Sin punto y coma (8.1).

Cambie la construcción, no solo las palabras (9.1). STE no es un intercambio de sinónimos.

No STE	Pobre (intercambio de palabras)	STE
The system should be allowed to cool down prior to commencing disassembly.	The system must be let to cool before start disassembly.	Let the system become cool. Then, disassemble the unit.
Having confirmed the valve is closed, proceed with removal of the pump.	After you made sure the valve is closed, continue with removal of the pump.	Make sure that the valve is closed. Then, remove the pump.
The cache may need to be cleared if stale data is displayed.	The cache must possibly be cleared if old data is shown.	If the page shows old data, clear the cache.

Principios para los tres trabajos

Precisión primero. STE cambia cómo se dice algo, no lo que se dice. Mantenga cada hecho, valor, tolerancia, condición y límite de alcance. No añada pasos, advertencias o valores que la fuente no contenga; ponga una posible brecha en las preguntas abiertas.

No adivine en silencio. Si la fuente es ambigua ("check the oil" — ¿el nivel o la condición?), seleccione el significado más probable y enumere el punto como una pregunta abierta. Mantenga la lista breve: solo puntos donde la respuesta cambie el texto. Tres buenas preguntas obtienen respuesta. Diez no.

Deje el texto no narrativo como está: código, comandos, rutas, etiquetas de interfaz, números de pieza, texto en placas, texto citado, texto legal.

Palabras que no están en dictionary.md. El archivo es un subconjunto, por lo que la mayoría de las palabras no están en él. Decida en esta secuencia y no haga una lista de palabras comunes "para confirmar":

1. ¿Está en las tablas de no aprobadas? Use la alternativa.
2. ¿Nombra una cosa o un proceso específico del campo temático? Es un sustantivo o verbo técnico. Úselo, de manera consistente.
3. ¿Hay una palabra más simple que sabe que está aprobada (la lista de verbos básicos, o una palabra en los ejemplos de STE)? Use esa palabra.
4. Si no, y la palabra es simple y tiene un significado claro aquí, úsela. Marque una palabra solo cuando una selección incorrecta pueda cambiar el significado.

Mayúsculas. El archivo del diccionario muestra las palabras aprobadas en MAYÚSCULAS como notación. Escríbalas en minúscula normal en documentos y en texto de informes ("use must", no "use MUST").

Todo lo que escriba para el usuario está también en STE: correcciones sugeridas, resúmenes de cambios y notas. Una corrección que tiene sus propias violaciones ("is usually done by deploying…") enseña lo incorrecto. Dé nombres de archivo, no rutas completas del sistema de archivos.

Afirmaciones. No diga que un documento está certificado o es completamente conforme. Diga que lo escribió o revisó según las reglas de STE. Dé el límite del diccionario en una oración, una vez. Si el cumplimiento es un requisito contractual, recomiende una revisión por parte de una persona capacitada en STE con la especificación oficial (gratuita a solicitud en asd-ste100.org).

Flujo de trabajo: Escribir

1. Identifique cada parte como un procedimiento (el lector hace algo) o una descripción (el lector aprende algo). Los límites son diferentes.
2. Haga la lista de términos: un sustantivo técnico para cada cosa, un verbo para cada proceso. Use el glosario del usuario si lo hay.
3. Escriba el borrador.
   • Procedimiento: pasos numerados, un comando cada uno, condiciones primero. Coloque cada advertencia o precaución inmediatamente antes de su paso, y cada nota después de su paso.
   • Descripción: párrafos cortos, oración temática primero.
   • Encabezados: una frase nominal corta o un comando ("Start the unit"), no una forma -ing.
4. Ejecute scripts/ste_check.py. Corrija los hallazgos. Ejecútelo de nuevo. Deténgase cuando cada hallazgo que permanece sea uno que examinó y aceptó.
5. Lea el borrador para los puntos que el script no puede encontrar: sustantivos compuestos, categoría gramatical, artículos, un término para una cosa, una instrucción en cada paso.
6. Entregue el documento. Después de él, en la respuesta (o debajo de una línea de regla, marcada como notas para el autor), proporcione:
   • los sustantivos y verbos técnicos de fuera del diccionario (no palabras aprobadas como remove o install);
   • las preguntas abiertas.

Flujo de trabajo: Revisar

1. Lea references/rules.md y references/dictionary.md.
2. Ejecute scripts/ste_check.py en el documento.
3. Examine los hallazgos y descarte los falsos positivos. Luego lea el documento para los puntos que el script no puede encontrar (paso 5 de Escribir) y para la estructura: posición de advertencias, instrucciones en notas, pasos con más de una acción.
4. Escriba el informe con esta estructura. Manténgalo lo suficientemente breve para actuar: una fila por cada oración que tenga un problema, y una fila por un problema que se repita en muchos lugares.

# Informe STE: <nombre de archivo>

## Resumen
<3-5 oraciones: tipo de texto, nivel general, las tres cosas más importantes a corregir primero.>

| Regla | Tema | Hallazgos |
|---|---|---|
| 1.1 | Palabra no aprobada | 12 |

## Hallazgos
| # | Ubicación | Regla | Texto original | Problema | Texto STE sugerido |
|---|---|---|---|---|---|
| 1 | Paso 2 | 3.6, 1.1 | "The cover should be removed" | Voz pasiva. "should" no está aprobado. | "Remove the cover." |

## Preguntas abiertas
<Solo si las hay. Máximo cinco.>

Reglas para el informe:

• Proporcione el número o números de regla para cada fila. Cite el texto original exactamente.
• Proporcione una corrección para cada fila y asegúrese de que la corrección cumpla las reglas (longitud, formas verbales, voz activa, palabras aprobadas).
• No reporte un encabezado como una oración larga o como un sustantivo compuesto si tiene tres sustantivos o menos.
• Si el nivel de una instrucción de seguridad parece incorrecto (por ejemplo, ADVERTENCIA por pérdida de datos), dígalo en la fila. ADVERTENCIA es para lesiones, PRECAUCIÓN para daños o pérdida de datos.
• No incluya cómo hizo el informe (recuentos del script, hallazgos falsos que descartó, una sección de "límites"). Una oración sobre el límite del diccionario en el resumen es suficiente.
• No reescriba el documento completo a menos que el usuario lo solicite.

Flujo de trabajo: Editar

1. Realice los pasos 1–3 de Revisar. Los hallazgos son su lista de trabajo, no el entregable.
2. Reescriba el documento. Mantenga la estructura, los encabezados, los números y todo el contenido técnico. Divida las oraciones largas y los pasos con múltiples acciones. Mueva cada advertencia o precaución a la posición antes de su paso. Convierta una instrucción en una nota en un paso o una instrucción de seguridad.
3. Ejecute scripts/ste_check.py en el resultado. Corríjalo y ejecute el script de nuevo, como en el paso 4 de Escribir.
4. Entregue el documento en el mismo formato que la fuente. Luego proporcione un breve resumen de cambios: los tipos principales de cambio con un ejemplo de antes y después de cada uno, cada lugar donde cambió la estructura o la fuerza de una declaración ("should" a "must", una nota a un paso), y las preguntas abiertas. No enumere cada oración cambiada a menos que el usuario solicite un registro completo de cambios.