edición-de-prosa

Edición de prosa

Asume que los hechos son correctos. Se trata de las palabras y la forma, no de los datos. NOTES.md junto a este archivo contiene ejemplos resueltos.

La prueba

Cada oración le dice al lector qué hacer, qué esperar o qué ocurre si se equivoca; corta toda oración que no haga ninguna de estas cosas. La concisión no es brevedad: nunca recortes contenido para alcanzar una extensión, corta el andamiaje que lo rodea.

Cortar

• Carraspeo. Pon el contenido en la primera oración.
• Reformulación. Dilo una vez, en el mejor lugar.
• Transiciones de relleno ("vale la pena señalar que", "como se mencionó anteriormente", "con el fin de").
• Editorialización que no cambia el comportamiento ("poco glamoroso pero importante").
• Cuantificación vaga ("una proporción sorprendente"). Da la razón real por la que funciona, o corta la afirmación.
• Titubeo que evita comprometerse. Expresa la incertidumbre real de forma clara, con los criterios de decisión.
• Citas en bloque para enfatizar. Resérvalas para advertencias que cambien lo que alguien hace.

Cortar lo que marca el texto como generado

Un modelo elige lo que encaja con el público más amplio; un escritor elige para un lector y un tema. Busca primero la estructura, porque los hábitos de palabras cambian con cada modelo. Una oración se queda solo si le da a este lector algo que no tiene.

• Preparación en lugar de afirmación. "No X sino Y" cuando nadie dijo X, un cierre de una línea que repite el punto, un preámbulo antes del punto, un dicho que suena profundo y no afirma nada. Expresa el hecho.
• Ritmo por regla. Tríadas y guiones en todas partes, aperturas de oración repetidas, calificadores apilados. Usa tres elementos cuando haya tres.
• Inflación. Hechos ordinarios llamados cruciales o robustos, lenguaje de ventas, autoridades sin nombre, muletillas con "-ando"/"-endo" que implican significado. Di lo que hace, o córtalo.
• Formato por regla. Negrita en cada elemento y un encabezado en cada pensamiento, donde el énfasis o la estructura no significan nada.
• Restos de borrador. Envolturas de chat, descargos sobre límites de conocimiento, un encabezado repetido como primera oración, texto sobre el documento en lugar de su tema.
• El lector equivocado. Reexplicar lo que ya saben, de modo que la decisión llegue al final.

Conserva lo que quiso decir el escritor y no añadas nada para reemplazar lo que cortaste. Un contraste real, una lista verdadera de tres o una fuente citada se quedan; un tic solo cuenta cuando no añade nada.

Protegido: el por qué nunca es superfluo

Conserva una oración que explique por qué (este orden, esta herramienta, esta comprobación primero, este paso no se puede omitir) aunque no dé ninguna instrucción: la razón permite que el lector maneje el caso que el documento no anticipó y vea cuándo el procedimiento ya no aplica. Da la razón siempre que no sea obvia, sobre todo para reglas de seguridad y cumplimiento, donde la intención es lo que permite a alguien aplicar la regla cuando ninguna otra la cubre. Cuando una oración tiene un adorno y una razón, reescríbela para conservar la razón. La prueba es "¿el lector estaría peor en esto sin ella?"

Cortar estructura inmerecida

Añade niveles, tablas, matrices, encabezados anidados o ramificaciones solo donde el trabajo los necesite, no porque parezcan rigurosos. Pregunta: ¿el trabajo realmente se ramifica aquí (si cada lector sigue el mismo camino, es una lista)? ¿Este paso es necesario o solo parece completo? Si el procedimiento tiene cuatro pasos, escribe cuatro: un procedimiento de cuatro pasos que se sigue en la primera lectura supera a uno correcto de nueve pasos que se hojea. Los obstáculos, las trampas de secuenciación y el por qué se quedan.

Instrucciones que carga un modelo

Las hojas de reglas, habilidades, archivos de rol y avisos se pagan en tokens cada vez que se cargan, y el lector es un modelo que necesita la regla, no la historia de la misma. Valóralas según cuándo se cargan (D28):

• Cada sesión (hojas de reglas, descripciones de habilidades y roles): solo la regla. Una descripción dice qué cubre la habilidad y cuándo cargarla, en menos de 300 caracteres; tools/check.py aplica los presupuestos.
• Al usar (el cuerpo de una habilidad o rol): la regla más una cláusula de razón. Solo un fallo concreto donde la regla parezca opcional sin él, sin fechas, recuentos ni nombres de proyectos.
• Bajo demanda (NOTES.md, EVIDENCE*.md): los incidentes, números, fechas y fuentes. El cuerpo apunta allí.

Escribe en imperativo. No replantees una regla que otro archivo cargado ya tiene; señálala por su nombre. Un requisito fijado en docs/REQUIREMENTS.tsv se mueve con su reescritura, nunca en silencio.

Forma de un procedimiento

Propósito → Cuándo usarlo → Antes de empezar → Pasos → Verificar → Si no funciona → Escalar

• Nunca omitas Verificar: es la parte que más a menudo se salta y la más valiosa.
• Una acción por paso. Nombra los elementos de la interfaz exactamente. Da la ruta completa.
• Señala los pasos irreversibles antes del paso, no después.
• Escribe para un desconocido competente: conoce el dominio, nunca ha visto este entorno.
• Los títulos nombran lo que alguien buscaría. Sin fechas, versiones ni "v2".

Tono

• Lenguaje llano, oraciones cortas.
• No suavices las restricciones con dientes (pérdida, terminación, pérdida de datos, responsabilidad personal): dilo claramente.
• Enlaza la documentación del proveedor en lugar de copiarla, y documenta solo lo que es específico de cómo trabajas: una reimpresión llega obsoleta.