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

<p>- Revisión: al escribir un texto, pensarlo varias veces para corregirlo y pulirlo; o bien, esa misma tarea<br /> - Por qué es necesaria la revisión<br /> - Tips de revisión<br /> → Hacer que tu texto se sienta ajeno: leerlo en voz alta, leerlo después de un tiempo, imprimirlo en papel y leerlo<br /> → Peer review <br /> → Uso de checklist <br /> → Tips para corregir oraciones y mejorar la legibilidad <br /> ① Resumir y corregir con oraciones cortas<br /> ② Eliminar expresiones innecesarias<br /> ③ Transformarlo en un texto lógico</p>

[budlebee]

<p>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:<br /> <br /> - Usa oraciones cortas y simples.<br /> - 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.<br /> - La versión revisada recorta un 10% del borrador. <br /> - Leer el texto en voz alta ayuda a detectar las partes incómodas de las oraciones. <br /> - Escribe definiendo con claridad a quién va dirigido el texto. En mi caso, es mi esposa. </p>

[xguru]

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