El arte de la revisión - Cómo escribir documentación técnica para desarrolladores

• Revisión: al escribir un texto, pensarlo varias veces para corregirlo y pulirlo; o bien, esa misma tarea

• Por qué es necesaria la revisión

• Tips de revisión

→ Hacer que tu texto se sienta ajeno: leerlo en voz alta, leerlo después de un tiempo, imprimirlo en papel y leerlo

→ Peer review

→ Uso de checklist

→ Tips para corregir oraciones y mejorar la legibilidad

① Resumir y corregir con oraciones cortas

② Eliminar expresiones innecesarias

③ Transformarlo en un texto lógico

[budlebee]

Me recuerda a los principios de escritura de Stephen King. Como se trata de novela, habrá diferencias con la escritura técnica, pero si lo escribo tal como se me viene a la mente:

• Usa oraciones cortas y simples.

• Después de escribir el borrador, lo guardo en un cajón y lo vuelvo a sacar seis meses después para leerlo de nuevo.

• La versión revisada recorta un 10% del borrador.

• Leer el texto en voz alta ayuda a detectar las partes incómodas de las oraciones.

• Escribe definiendo con claridad a quién va dirigido el texto. En mi caso, es mi esposa.

[xguru]

Últimamente, la gente de technical writing de Kakao Enterprise está publicando muchos buenos artículos. ¡Recomiendo suscribirse al blog!